Skip to content

Waldur Documentation

Description Documentation of an open-source marketplace platform Waldur. See the latest version at https://docs.waldur.com
Copyright Copyright © 2016 - 2025 Waldur team

About ↵

Getting started

Installing Waldur is a simple and straightforward process.

Pick method of installation

There are 2 supported methods:

Configure Waldur

Tune Waldur configuration to match your deployment. Majority of the configuration is done on Mastermind side. Exact method of configuration depends on the chosen method of installation. Settings are grouped by modules, you can see all available ones in the configuration guide.

The most typical aspects for configuration are:

Tip

For easier management of Waldur deployments and configuration we provide Ansible playbooks.

Profit

You are done! If you are happy and want to support the project, make sure you check the support page.

Danger

Before going to production, make sure you have completed the go-live checklist.

Contributing

Waldur is an open project welcoming contributions. To assure the smooth acceptance of contributions please review the contribution guidelines below.

Pull requests

We welcome contributions (patches, new features, translations, etc) through pull requests. Please make sure that the following is addressed when making a pull request:

  • a request has a clear scope - new feature, bugfix, refactoring. Granular pull requests make integration much faster;
  • the code is following code conventions of the corresponding platform and linters / tests are passing;

Localisation

If you see a term, which needs to be translated better, please submit a fix via Localazy.

License

All contributions to Waldur can be accepted only you agree to license your contribution under the MIT license. Please make sure that you have the right to sign off code as MIT.

Code repositories

Repository Description
HomePort Code of Waldur Homeport web interface
MasterMind Code of Waldur Mastermind orchestrator
Helm package Helm packaging of Waldur for Kubernetes
Docker-compose Docker-compose packaging of Waldur
Ansible module Ansible module for Waldur APIs

Data processing disclaimer

Waldur developers would like to inform that we do not assume any responsibility for processing data generated or handled by the software.

Users (e.g platform operators, platform users) are solely responsible for ensuring that the data processed through our software complies with applicable laws, regulations, and industry standards. Waldur developers disclaim any liability for loss, damage, or unauthorized access to data from our software.

Our role is limited to the development of software solution. We do not control, manage, or take responsibility for our software processes' specific deployments and data, including but not limited to data storage, transmission, or any associated security measures.

Users are encouraged to implement data protection and security measures to secure their information. By using Waldur software, users acknowledge and agree that Waldur developers are not liable for any issues related to data processing.

Some highlights to keep in mind regarding user data processing in Waldur

  • Platform operator should have a DPA (Data Processing Agreement) with every Service Provider connected to the platform because, in case of a service request from a Service Provider, the latter gets the ability to see members of the project whereas service is to be provisioned. For example, an HPC service gets access to project member information only when the project is requesting access to the service. The access is revoked once the service is terminated.
  • Staff users (usually platform operators) can see all users personal information.
  • User profile modifications are logged, including modifier network address and changes for auditing and tracing abilities. Additionally, operations connected with the user, e.g. adding or removing SSH key, are also logged.
  • The authentication system is designed around the federated AAI solution, where a user is expected to conform explicitly to personal data propagation from the Identity Provider (IdP) to Waldur.
  • In cases when policy allows, it is possible to create a non-personalized group or robot account to act on behalf of the user, e.g. for CICD types of workflows.
  • All event logs contain references to a user - by UUID - if they are connected with the user. This allows the platform operator to have an easy information cleanup for user data according to specific deployment policies (e.g. removing data of deactivated users after two years) and to disclose user data easily collected about them.

Some suggestions to ensure that the data is securely protected

  • Waldur is pretty configurable, this means that the Waldur deployment operator can configure user profiles in a way that the information requested about the users is as minimal as possible.
  • User information is visible to all project members, so make sure that you include only these users in the project, who are allowed to see each other's information. In addition to that, organization managers can see the user information about users connected to that organization.

Governance

Waldur is a project co-developed by OpenNode and University of Tartu with contributions from different organizations. To make sure that the project is delivering a sound product, OpenNode maintains control over the authoritative source code and covers Product owner and Architect roles (see below).

Waldur and all of its components are released under MIT license to be as friendly towards ecosystem as possible.

Overview of the development process

Waldur team tries to maintain a transparent process of development. In a team, each person can have one or more of the roles below.

Roles

  • Project manager - collects and provides requirements for a particular Waldur-based project. Multiple people can have this role.
  • Product owner - analysis requirements from project managers and fits into a product roadmap. Maintains technical feature list. Single person at a time can have this role.
  • Architect - oversees Waldur platform development, including backend, frontend, external tools. Has a final word on the way how components are integrated. Single person at a time can have this role.
  • Developer - responsible for fulfilling tasks created. Multiple people can have this role.

Workflow

  • Project manager communicates with customers, defines requirements for product owner.
  • Product owner analyses requirements from all projects and creates epics for technical features implementation. Epics are assigned to the architect.
  • Architect defines general development plan for features from product owner, adds description to the epic and creates separate tasks or stories for component owners.
  • Developers process tasks.
  • Product owner releases tagged versions of the product once a certain amount of functionality or bugfixes went in.

Marketplace concept

Overview

The Waldur Marketplace serves as a centralized platform for requesting, provisioning, and managing resources from various service providers. This guide explains key concepts and workflows in the Marketplace to help you effectively navigate and utilize its features.

Core concepts

Marketplace framework

The Marketplace operates through four integrated modules:

  1. Structure module: Establishes organizational hierarchy through Organizations and Projects, with access controls enforced at the project level.

  2. Service catalogue module: Enables Service providers to configure Offerings with pricing models (Plans), resource components, and customized request forms.

  3. Provisioning module: Manages the complete resource lifecycle from order placement to resource creation, usage tracking, and termination.

  4. Billing module: Handles financial tracking, invoicing, and cost management for resources provisioned through the Marketplace.

Key components

  • User: An individual who accesses the Waldur system with specific permissions within one or more organizations.
  • Organization: A business entity that can act as a customer, a service provider, or both within the Waldur system.
  • Project: A logical container for resources that belongs to an organization, with its own access control settings.
  • Project member: A user who has been assigned specific permissions within a project.
  • Service provider: An organization authorized to publish and deliver services through Waldur.
  • Marketplace plugin: A software component that integrates a specific backend system (like OpenStack or SLURM) with the Waldur Marketplace.
  • Order: A formal request for resource provisioning submitted by a user.
  • Resource: The provisioned service instance that results from a fulfilled order.
  • Offering: A specific service available for provisioning (e.g., virtual machines, HPC compute time).
  • Plan: A pricing and resource allocation model for an offering.
  • Plugin registry: A central repository that maintains information about available backend services and their connection details.
  • Invoice: A financial document detailing resource usage costs for an organization.
  • Invoice Item: An individual billing entry for a specific resource's consumption.

Architectural framework

flowchart TD
    %% Structure module
    subgraph Structure[Structure module]
        Org[Organization]
        User[User]
        Proj[Project]
        ProjMember[Project member]
        ServiceProvider[Service provider]
    end

    %% Service catalogue module
    subgraph Catalog[Service catalogue module]
        Offering[Offering]
        Plan[Plan]
        PluginReg[Plugin registry]
    end

    %% Provisioning module
    subgraph Provisioning[Provisioning module]
        Order[Order]
        Resource[Resource]
        MarketplacePlugin[Marketplace plugin]
    end

    %% Billing module
    subgraph Billing[Billing module]
        Invoice[Invoice]
        InvoiceItem[Invoice item]
    end

    %% Key Relationships
    Org -- has --> Proj
    Org -- becomes --> ServiceProvider
    User -- belongs to --> Proj
    User -- creates --> ProjMember
    ServiceProvider -- provides --> Offering
    Offering -- connects to --> PluginReg
    Offering -- defines --> Plan

    ProjMember -- submits --> Order
    Order -- approved by --> ServiceProvider
    Order -- creates --> Resource
    MarketplacePlugin -- processes --> Resource

    Resource -- generates --> InvoiceItem
    InvoiceItem -- belongs to --> Invoice
    Invoice -- billed to --> Org
    Resource -- instantiated from --> Offering
    Proj -- contains --> Resource

    classDef structureModule fill:#5BAD60,stroke:#333,stroke-width:1px
    classDef catalogModule fill:#5BAD60,stroke:#333,stroke-width:1px
    classDef provisioningModule fill:#5BAD60,stroke:#333,stroke-width:1px
    classDef billingModule fill:#5BAD60,stroke:#333,stroke-width:1px

    class Org,User,Proj,ProjMember,ServiceProvider structureModule
    class Offering,Plan,PluginReg catalogModule
    class Order,Resource,MarketplacePlugin provisioningModule
    class Invoice,InvoiceItem billingModule

Offering requirements

For an offering to appear in the Marketplace, it must include:

  • Category assignment: Determines the offering's location in the Marketplace browsing hierarchy.
  • Basic information: Name, description, plugin type, and service settings.
  • Plan configuration: At least one plan defining resource limits and pricing structure.
  • Component definitions: Specific resources being measured or billed.
  • Visibility settings: Configuring which customers or projects can access the offering.
  • Optional attributes: Custom parameters that users must provide when ordering.

Supported integration plugins

The Marketplace supports various backend systems through dedicated plugins. Here are examples of commonly used plugins:

  • OpenStack plugin: Provisions virtual infrastructure including VMs, storage volumes, networks, and IP addresses.
  • SLURM plugin: Facilitates access to HPC cluster resources with consumption typically measured in CPU or GPU hours.

These are just examples of the available integrations. Waldur's plugin architecture allows for connecting to a wide range of service backends. Each plugin has specific configuration requirements detailed in its dedicated documentation section.

Service providers can leverage these existing plugins or develop custom integrations to make their specific services available through the Marketplace.

Resource lifecycle

Resources in the Marketplace follow a defined lifecycle:

  1. Publication: Service Provider creates and publishes an offering with associated plans.
  2. Order placement: User selects an offering, chooses a plan, and submits an order within a project context.
  3. Approval process: Orders may require authorization by project or customer owners based on configured policies.
  4. Provisioning: Upon approval, the system automatically provisions the requested resource via the appropriate plugin.
  5. Usage monitoring: The system tracks resource consumption for accounting and reporting purposes.
  6. Management operations: Users can perform lifecycle operations (update, pause, terminate) as permitted by the plugin and their access rights.

Next steps

To learn more about specific offerings or how to perform common tasks in the Marketplace, refer to the following guides:

Usage examples

Here are some common scenarios to help you understand how to use the Marketplace effectively:

Requesting a Virtual Machine

  1. Navigate to the Marketplace
  2. Filter offerings by the "Virtual Machines" category
  3. Select the OpenStack offering from your preferred provider
  4. Choose the plan that matches your requirements (e.g., "Small VM" with 2 vCPUs, 4GB RAM)
  5. Fill in required parameters (name, SSH key, etc.)
  6. Submit your order
  7. Once approved, your VM will be provisioned and appear in your project's resources

Managing HPC allocation

  1. Access your project dashboard
  2. Select the SLURM allocation from your resources list
  3. View current usage statistics for CPU hours and storage
  4. If needed, request an extension through the "Modify Resource" option
  5. Submit jobs through the provided access methods

Cost optimization

Monitor your resource usage regularly through the dashboard to avoid unexpected charges. For VM resources, remember to shut down instances when not in use, as many providers charge based on uptime regardless of actual CPU utilization.

Approval workflows

Some offerings may require approval from your organization owner or the service provider before provisioning begins. You can check the status of your order in the Orders section of your project dashboard.

Academic publications

Reporting issues

No software is perfect, and issues are to be expected. If you observe something that you think needs fixing, please provide a detailed issue report using the guidelines below.

Where to report issues

Choose the appropriate channel to report your issue:

  1. Internal issue management (Atlassian JIRA)
  2. If you have access to the internal issue management system, please report the issue through Atlassian JIRA
  3. Use the appropriate project for the component experiencing the issue

  4. Follow your organization's internal guidelines for issue categorization

  5. GitHub Issues

  6. If you don't have access to internal issue management, report issues on GitHub
  7. Visit the appropriate repository under the Waldur organization
  8. Select the repository that corresponds to the component with the issue (e.g., HomePort, MasterMind)
  9. Create a new issue using the provided templates when available

Not sure which component has the issue?

If you're uncertain whether the issue is with HomePort or MasterMind, please provide:

  1. Description of the problem

    • What you were trying to do
    • What happened instead
    • Any error messages you saw

  2. Screenshots of the error at high resolution

    • Include the entire screen if possible to provide context
    • Ensure text is legible

  3. Basic environment information

    • Browser type and version (if applicable)
    • URL where the issue occurred
    • Time and date when you encountered the issue
    • Waldur version (if known)

This information will help us determine which component is affected and guide you on additional details we might need.

Required information for all issues

The following information is helpful for troubleshooting any issue:

  1. Environment details

    • Waldur instance hostname
    • Deployment type (select one):
      • Docker-compose
      • Helm
      • ArgoCD

  2. Affected URL(s)

    • Include the exact page where the issue occurs

  3. User-specific details (if applicable)

    • User roles in different scopes (project, organization, call, offering, etc.)
    • Whether user has global role (staff or support)
    • If reproducible in test environment, provide the specific username

  4. Details of affected Waldur objects

    • Customer name
    • Project name
    • Resource name
    • Any other relevant identifiers

Homeport-specific issues

When reporting issues specifically with HomePort, please also include:

  1. HAR request file that has failed or contains data required for rendering

Mastermind-specific issues

When reporting issues specifically with MasterMind, please also include:

  1. Logs

Warning

Logs may contain sensitive data. Please ensure you either clean up the data or share it only with trusted parties before submitting.

Best practices for issue reports

  • Be specific about the steps to reproduce the issue
  • Mention which browser and version you're using (for frontend issues)
  • Include timing information (when did it start occurring, is it intermittent, etc.)
  • Note any recent changes that might be related to the issue
  • Provide as much context as possible to help with troubleshooting
  • If possible, indicate if the issue can be consistently reproduced or occurs randomly

Screenshots

Desktop view

Login page

Landing

Organization dashboard

Organization dashboard

Project dashboard

Project dashboard Resource list HPC details OpenStack details

Provider reporting and support dashboard

Monthly revenue Growth reporting Support view

Call management dashboard

Call management

Marketplace

Marketplace VPC creation SLURM creation

Admin dashboard

Admin dashboard

Mobile view

Login page

Landing

Organization dashboard

Organization dashboard

Project dashboard

Project dashboard Resource list HPC details OpenStack details

Provider reporting and support dashboard

Monthly revenue Growth reporting Support view

Marketplace

Marketplace Marketplace VPC creation SLURM creation

Admin dashboard

Admin dashboard

Support

Waldur is an open-source project co-developed by OpenNode and University of Tartu.

Support and sponsored development

OpenNode provides several options for support with varying SLAs.

If you would like to know more, reach out!

Managed hosting for academical institutions

Please reach out to support@hpc.ut.ee if you represent an R&D organization and interested in managed Waldur hosting.

Glossary

Name Description Examples
Organization Legal representation of the entity that can be a client of the Operator. Ministry A, Department B
Project Functionality in Self-Service Portal, which allows to group internal resources into projects, which allows to limit access to resources for people. Internal systems, Public web
Service Provider Organization can publish offerings in marketplace as soon as it is registered as service provider. ETAIS, UT HPCC
Offering Service Offering from Service Provider, which can be requested via a Marketplace. Correspond to an entry in the Service Catalogue. VPS with LB, VDC in DataCenter 1
Category A grouping of the Offerings defining metadata common to all offerings in this Category. Compute, Storage, Operations
Section Section is a named aggregate of offering attributes. System information, Support, Security
Attribute Attribute is an atomic piece of offering metadata, it has name, type and list of options. Peak TFlop/s, Memory per node (GB)
Plan An option for paying for a particular Offering. There can be multiple options but at each point in time only one Plan can be active. Small private cloud, Big private cloud
Order A collection of Order items. Considered as done when all Order Items have been processed. 3 different Offerings with configuration.
Order Item Connects Offering with concrete Organization and configuration settings. Small VPC with name “test”
Resource Created as part of fulfilling the Order Item. Represents part of the Offering that customer Organization can use. VM, VPC
Category component Specifies unit of measurement, display name and internal name of the component, which should be present in every category offerings. It is used for aggregating offering component usage and rendering dashboard charts in both project and organization workspace. vCPU, RAM, storage
Offering component Usage-based component that constitute offering. It may refer to the category component via parent field in order to ensure that component usage is aggregated. Database count, disk usage
Plan Component Components that constitute a plan. vCPU, RAM, storage, network bandwidth
Component usage Collects reported resource usage for each plan component separately. 5 virtual floating IPs for the last month.

Roles and permissions

Users, Organizations and Projects

Waldur is a service for sharing resources across projects. It is based on the delegation model where an organization can allocate certain users to perform technical or non-technical actions in the projects.

The most common types of Waldur installations include:

  • Cloud - used in commercial or government sectors for providing access to cloud resources like virtual machines, storage and Kubernetes clusters.
  • Academic - used in research and education. Waldur is deployed for a single university, high school or research infrastructure.
  • Academic Shared - the same purpose as Academic, but is shared among several universities or infrastructures.

User

An account in Waldur belonging to a person or a robot. A user can have roles in Organizations and Projects. Some users - mostly affiliated with Waldur operator - can have global roles, e.g. support or staff.

Organization

A company or a department. Organization can be a customer, a service provider or both.

A faculty, department or an institute. Organization can be also a service provider, for example, an HPC center.

In Academic Shared model, all organizations are service providers allocating resources to their users (research groups or classes) through their Projects.

Project

A project within an Organization. Used for organizing and isolating Resources and Users.

Service Provider

Organization that provides services to other organizations.

User types

User Support agent Staff
Web and API access
Can create support requests
Can provide user support
Can see all projects and resources
Can manage organizations
Can access admin area

User roles in Organization

Owner Service Manager Project Manager System Administrator
Manage Team (pre-approved users)
Manage Projects
Request and Manage Resources
Approves creation of Resource Requests (Orders) (configurable)
Approves Resource Requests (Orders)
Manage Offerings (Service provider-specific)
PI Service Manager co-PI Member
Manage Team (pre-approved users)
Manage Projects
Request and Manage Resources
Approves creation of Resource Requests (Orders) (configurable)
Approves Resource Requests (Orders)
Manage Offerings (Service provider-specific)
Resource allocator Service Manager PI co-PI Member
Manage Team (pre-approved users)
Manage Projects
Request and Manage Resources
Approves creation of Resource Requests (Orders) (configurable)
Approves Resource Requests (Orders)
Manage Offerings (Service provider-specific)

User roles in Call management

Role name Scope Description
Organization owner Customer Has full administrative access to manage organizations, offerings, orders, resources, projects, and call-related permissions.
Call organiser Call organizer Manages calls at the organization level, similar to Call manager but restricted to a specific customer scope.
Call manager Call Oversees the entire call process, including managing proposals, approving/rejecting applications, closing rounds, and handling permissions.
Call reviewer Call Reviews and evaluates submitted proposals within a call.
Proposal member Proposal Manages individual proposals, controlling their status and related workflows.

Ended: Terminology

Changelog

7.7.7

Notes: Extra lucky

Date: Fri Aug 29 21:50:45 UTC 2025

7.7.6

Notes: None

Date: Sun Aug 24 19:56:01 UTC 2025

7.7.5

Notes: None

Date: Thu Aug 14 00:35:08 EEST 2025

7.7.4

Notes: None

Date: Thu Jul 31 08:39:40 UTC 2025

7.7.3

Notes: None

Date: Fri Jul 25 20:05:56 UTC 2025

7.7.2

Notes: None

Date: Wed Jul 23 16:42:28 UTC 2025

7.7.1

Notes: None

Date: Sun Jul 20 19:23:40 UTC 2025

7.7.0

Notes: Bugfixes and extensions

Date: Tue Jul 15 19:04:55 UTC 2025

7.6.9

Notes: Bugfixes

Date: Sun Jul 13 17:46:26 UTC 2025

7.6.8

Notes: Bugfixes and extensions

Date: Thu Jul 10 16:51:05 UTC 2025

7.6.7

Notes: None

Date: Sat Jul 5 19:36:57 UTC 2025

7.6.6

Notes: Fix of a broken migration

Date: Wed Jul 2 21:47:08 UTC 2025

7.6.5

Notes: Bugfixes

Date: Wed Jul 2 17:51:18 UTC 2025

7.6.4

Notes: None

Date: Tue Jun 17 17:33:55 UTC 2025

7.6.3

Notes: None

Date: Tue Jun 10 20:41:54 UTC 2025

7.6.2

Notes: None

Date: Mon Jun 9 19:32:51 UTC 2025

7.6.1

Notes: Bugfix

Date: Tue Jun 3 20:56:25 UTC 2025

7.6.0

Notes: Bugfixes

Date: Mon Jun 2 20:16:44 UTC 2025

7.5.9

Notes: None

Date: Wed May 28 19:33:40 UTC 2025

7.5.8

Notes: Bugfix

Date: Fri May 23 18:06:29 UTC 2025

7.5.7

Notes: Network bugfixes

Date: Thu May 22 19:39:06 UTC 2025

7.5.6

Notes: None

Date: Wed May 21 19:28:01 UTC 2025

7.5.5

Notes: Bugfix

Date: Mon May 19 15:40:55 UTC 2025

7.5.4

Notes: Bugfix

Date: Tue May 13 12:37:21 UTC 2025

7.5.3

Notes: Bugfixes and extensions

Date: Mon May 12 18:13:33 UTC 2025

7.5.2

Notes: Minor improvements

Date: Mon May 5 19:23:46 UTC 2025

7.5.1

Notes: None

Date: Tue Apr 29 15:44:18 UTC 2025

7.5.0

Notes: Bugfix

Date: Thu Apr 24 03:45:18 UTC 2025

7.4.9

Notes: None

Date: Tue Apr 22 14:26:40 UTC 2025

7.4.8

Notes: Bugfix release

Date: Mon Apr 7 07:13:39 UTC 2025

7.4.7

Notes: Bugfix release

Date: Thu Mar 27 18:56:04 UTC 2025

7.4.6

Notes: None

Date: Wed Mar 26 21:27:56 UTC 2025

7.4.5

Notes: None

Date: Sun Mar 23 21:29:43 UTC 2025

7.4.4

Notes: None

Date: Wed Mar 19 17:42:10 UTC 2025

7.4.3

Notes: Use psycopg 3 PostgreSQL driver for Celery result backend

Date: Mon Mar 17 09:54:08 UTC 2025

7.4.2

Notes: Updated postgresql driver

Date: Sun Mar 16 22:10:21 UTC 2025

7.4.1

Notes: Bugfix release

Date: Wed Mar 12 18:46:14 UTC 2025

7.4.0

Notes: Bugfix release

Date: Tue Mar 11 19:54:43 UTC 2025

7.3.9

Notes: Bugfix

Date: Thu Mar 6 21:51:24 UTC 2025

7.3.8

Notes: Bugfix of daily quota widgets

Date: Fri Feb 28 22:00:31 UTC 2025

7.3.7

Notes: Bugfixes, extended tenant replication capabilities

Date: Fri Feb 28 17:02:21 UTC 2025

7.3.6

Notes: Bugfix

Date: Mon Feb 24 08:51:19 UTC 2025

7.3.5

Notes: Bugfix

Date: Sun Feb 23 20:30:42 UTC 2025

7.3.4

Notes: None

Date: Sat Feb 22 19:55:18 UTC 2025

7.3.3

Notes: Bugfix release

Date: Fri Feb 14 19:17:37 UTC 2025

7.3.2

Notes: None

Date: Thu Feb 13 18:59:06 UTC 2025

7.3.1

Notes: Bugfixes

Date: Thu Feb 13 09:24:01 UTC 2025

7.3.0

Notes: None

Date: Tue Mar 11 19:54:43 UTC 2025

7.2.9

Notes: Bugfix

Date: Thu Mar 6 21:51:24 UTC 2025

7.2.8

Notes: Bugfix of daily quota widgets

Date: Fri Feb 28 22:00:31 UTC 2025

7.2.7

Notes: Bugfixes, extended tenant replication capabilities

Date: Fri Feb 28 17:02:21 UTC 2025

7.2.6

Notes: Bugfix

Date: Mon Feb 24 08:51:19 UTC 2025

7.2.5

Notes: Bugfix

Date: Sun Feb 23 20:30:42 UTC 2025

7.2.4

Notes: None

Date: Sat Feb 22 19:55:18 UTC 2025

7.2.3

Notes: Bugfix release

Date: Mon Dec 30 10:50:45 UTC 2024

7.2.2

Notes: Bugfixes

Date: Tue Dec 24 14:28:07 UTC 2024

7.2.1

Notes: Bugfix release

Date: Wed Dec 18 21:58:41 UTC 2024

7.2.0

Notes: Bugfixes

Date: Tue Dec 17 22:53:25 UTC 2024

7.1.9

Notes: Bugfix release

Date: Thu Dec 12 20:51:10 UTC 2024

7.1.8

Notes: SBOM release

Date: Thu Dec 12 14:31:04 UTC 2024

7.1.7

Notes: Bugfixes

Date: Sun Dec 1 20:44:47 UTC 2024

7.1.6

Notes: Revert refactoring of OIDC redirect URLs

Date: Fri Nov 29 11:03:18 UTC 2024

7.1.5

Notes: Bugfixes and improvements

Date: Thu Nov 28 20:23:37 UTC 2024

7.1.4

Notes: Bugfixes

Date: Tue Nov 19 21:56:14 UTC 2024

7.1.3

Notes: Bugfixes

Date: Mon Nov 18 20:21:38 UTC 2024

7.1.2

Notes: Bugfixes

Date: Mon Nov 18 10:13:10 UTC 2024

7.1.1

Notes: Bugfixes

Date: Tue Nov 12 18:06:51 UTC 2024

7.1.0

Notes: Extended agent, bugfixes

Date: Sat Nov 9 14:58:15 UTC 2024

7.0.9

Notes: Bugfix release

Date: Tue Nov 5 12:07:24 UTC 2024

7.0.8

Notes: Bugfix release

Date: Fri Nov 1 22:01:20 UTC 2024

7.0.7

Notes: Bugfix

Date: Thu Oct 24 21:47:19 UTC 2024

7.0.6

Notes: Bugfixes and improvements

Date: Wed Oct 23 19:43:43 UTC 2024

7.0.5

Notes: Bugfix release

Date: Thu Oct 17 19:44:16 UTC 2024

7.0.3

Notes: Expose set usage action in provider resource view

Date: Sun Oct 13 10:51:03 UTC 2024

7.0.2

Notes: Initial version of migration

Date: Fri Oct 11 20:32:54 UTC 2024

7.0.1

Notes: Bugfix release

Date: Wed Oct 9 21:28:21 UTC 2024

7.0.0

Notes: Bugfix release

Date: Tue Oct 1 19:48:59 UTC 2024

6.9.9

Notes: None

Date: Sun Sep 29 08:20:55 UTC 2024

6.9.8

Notes: Bugfixes

Date: Tue Sep 17 21:37:59 UTC 2024

6.9.7

Notes: Improved username display in team tabs, bugfixes.

Date: Fri Sep 13 14:15:32 UTC 2024

6.9.6

Notes: Openstack bugfixes

Date: Wed Sep 11 18:38:37 UTC 2024

6.9.5

Notes: Bugfix release

Date: Wed Sep 11 10:11:47 UTC 2024

6.9.4

Notes: Fix initialization of resource options

Date: Tue Sep 10 07:29:29 UTC 2024

6.9.3

Notes: Fix docker executor issue due to a conflict with requests

Date: Mon Sep 9 11:25:59 UTC 2024

6.9.2

Notes: Bugfixes, start of merging of Openstack applications.

Date: Thu Sep 5 13:40:32 UTC 2024

6.9.1

Notes: Bugfix release

Date: Tue Aug 27 10:37:35 UTC 2024

6.9.0

Notes: Resource option update bugfix

Date: Sun Aug 25 20:35:08 UTC 2024

6.8.9

Notes: Bugfixes

Date: Fri Aug 23 17:49:29 UTC 2024

6.8.8

Notes: None

Date: Wed Aug 21 19:47:22 UTC 2024

6.8.7

Notes: Allow exposing external IPs for Openstack deployments

Date: Sat Aug 17 08:00:05 UTC 2024

6.8.6

Notes: Bugfixes

Date: Thu Aug 15 16:25:26 UTC 2024

6.8.5

Notes: Extended user-onboarding options

Date: Wed Aug 14 10:10:26 UTC 2024

6.8.4

Notes: User management UI improvements

Date: Sun Aug 11 19:44:26 UTC 2024

6.8.3

Notes: Bugfix

Date: Thu Aug 8 09:41:55 UTC 2024

6.8.2

Notes: Introduce new configuration method in HomePort

Date: Wed Aug 7 11:01:56 UTC 2024

6.8.1

Notes: Fix resource name suggestion button

Date: Thu Aug 1 19:14:05 UTC 2024

6.8.0

Notes: Bugfixes

Date: Wed Jul 31 18:44:21 UTC 2024

6.7.9

Notes:

Date: Thu Jul 25 08:33:49 UTC 2024

6.7.8

Notes:

  • Bugfix

  • Extended SSH key hashes with sha256 and sha512

  • Waldur Mastermind: tag diff

  • Waldur Homeport: tag diff
  • Waldur Helm: tag diff
  • Waldur Docker Compose: tag diff
  • Waldur Prometheus Exporter: tag diff

Date: Sun Jul 21 18:05:27 UTC 2024

6.7.7

Notes: Bugfix

Date: Sun Jul 14 20:31:27 UTC 2024

6.7.6

Notes: Fix support configuration loading

Date: Thu Jul 11 15:01:09 UTC 2024

6.7.5

Notes: Bugfix

Date: Thu Jul 11 10:44:33 UTC 2024

6.7.4

Notes: Bugfixes

Date: Mon Jul 8 15:26:54 UTC 2024

6.7.3

Notes: Fixes broken 6.7.2 release

Date: Mon Jul 1 14:12:05 UTC 2024

6.7.2

Notes: None

Date: Sun Jun 30 19:51:44 UTC 2024

6.7.1

Notes: Bugfix release

Date: Fri Jun 21 21:40:08 UTC 2024

6.7.0

Notes: Introducing renewed UI

Date: Mon Jun 17 15:42:36 UTC 2024

6.6.9

Notes: None

Date: Tue Apr 30 07:40:46 UTC 2024

6.6.8

Notes: Bugfixes.

Date: Mon Apr 29 08:54:03 UTC 2024

6.6.7

Notes: Bugfixes

Date: Fri Apr 26 15:11:26 UTC 2024

6.6.6

Notes: Fix user management permissions.

Date: Mon Apr 22 16:07:21 UTC 2024

6.6.5

Notes: None

Date: Fri Apr 19 11:05:01 UTC 2024

6.6.4

Notes: Volume type selector bugfix

Date: Sun Apr 7 08:45:51 UTC 2024

6.6.3

Notes: Add support for Matomo user tracking

Date: Thu Apr 4 17:29:13 UTC 2024

6.6.2

Notes: Bugfix release

Date: Wed Apr 3 09:04:26 UTC 2024

6.6.1

Notes: Bugfix

Date: Mon Apr 1 15:40:22 UTC 2024

6.6.0

Notes: None

Date: Mon Apr 1 13:43:17 UTC 2024

6.5.9

Notes: SMAX configuration bugfix

Date: Tue Mar 26 21:45:17 UTC 2024

6.5.8

Notes: Bugfixes

Date: Tue Mar 26 19:20:27 UTC 2024

6.5.7

Notes: Bugfixes

Date: Mon Mar 25 17:45:10 UTC 2024

6.5.6

Notes: Bugfix release

Date: Fri Mar 15 20:08:05 UTC 2024

6.5.5

Notes: Openstack caching bugfix

Date: Tue Mar 12 19:31:25 UTC 2024

6.5.4

Notes: Bugfix

Date: Mon Mar 11 20:22:24 UTC 2024

6.5.3

Notes: Bugfix

Date: Thu Mar 7 18:23:33 UTC 2024

6.5.2

Notes: None

Date: Tue Mar 5 21:29:54 UTC 2024

6.5.1

Notes: Bugfix

Date: Tue Feb 27 20:45:36 UTC 2024

6.5.0

Notes: Bugfix release

Date: Mon Feb 26 22:29:21 UTC 2024

Ended: About

Admin guide ↵

Architecture

Waldur is composed of several components that work together to provide a comprehensive cloud management platform.

Components

  • Homeport (web client, graphical interface) - React application
  • Waldur site agent - Remote agent for managing provider resources and synchronizing data
  • Mastermind API server - Django/Django REST Framework application implementing the core business logic
  • Celery workers - Background processing of tasks
  • Celery beat - Scheduling of periodic tasks for background processing
  • PostgreSQL database - Storing persistent data, also serves as Celery result store in Kubernetes deployment
  • RabbitMQ - Tasks queue and result store for Celery

Architecture diagram

flowchart TD
    User[👤 User] --> Browser[🌐 Web Browser]
    Browser --> |Sends request| Homeport[🏠 Homeport<br/>React Application]
    Homeport --> |API calls| API[🔧 Mastermind API<br/>Django/DRF Server]

    Agent[🤖 Waldur Site Agent<br/>Remote Resource Manager] --> |API calls| API

    API --> |Saves data| DB[(🗄️ PostgreSQL<br/>Database)]
    API --> |Pushes tasks| Queue[📋 Task Queue<br/>RabbitMQ]

    Worker[⚙️ Celery Worker<br/>Background Processing] --> |Pulls tasks| Queue
    Worker --> |Saves results| DB

    Beat[⏰ Celery Beat<br/>Task Scheduler] --> |Schedules periodic tasks| Queue

    classDef frontend fill:#d5e8d4,stroke:#82b366,stroke-width:2px
    classDef backend fill:#dae8fc,stroke:#6c8ebf,stroke-width:2px
    classDef infrastructure fill:#fff2cc,stroke:#d6b656,stroke-width:2px
    classDef agent fill:#f8cecc,stroke:#b85450,stroke-width:2px

    class User,Browser,Homeport frontend
    class API,Worker,Beat backend
    class DB,Queue infrastructure
    class Agent agent

Backups

Waldur keeps state in 2 components:

  • Database - main persistency layer.
  • Message queue - contains transient data mostly about scheduled jobs and cache.

Of these, only database needs to be backed up.

A typical approach to a backup is:

1. Create a DB dump

  1. An entire db dump
1
docker exec -t waldur-db pg_dump -U waldur waldur | gzip -9 > waldur-$(date +'%Y%m%dT%H%M%S').sql.gz
  1. An entire db dump with cleanup commands:
1
docker exec -t waldur-db pg_dump --clean -U waldur waldur | gzip -9 > waldur-$(date +'%Y%m%dT%H%M%S').sql.gz
  1. A db dump containing only data
1
docker exec -t waldur-db pg_dump -a -U waldur waldur | gzip -9 > waldur-$(date +'%Y%m%dT%H%M%S').sql.gz

2. Copy backup to a remote location

Using rsync / scp or more specialised tools.

3. Restore the created backup

1
cat waldur-backup.sql | docker exec -i waldur-db psql -U waldur

We suggest to make sure that backups are running regularly, e.g. using cron.

Billing and accounting in Waldur

Waldur's accounting and billing components are responsible for collecting accounting data and presenting it to end users. It features built-in reporting and accounting functionality, enabling the tracking of usage information for each project and its resources. During the service offering creation process, providers can define accounting components (such as CPU-h, GPU-h, and storage for HPC; CPU, RAM, and storage for VMs) and set the pricing plans for each component. Consumers can view usage information according to the policies established by the provider.

From a provider point of view, Waldur supports invoice generation and exposes enough of information via APIs to integrate with custom payment providers.

Waldur offers convenient tools for consumers to view resource usage information. The user interface displays overall usage data within a project and breaks down monthly usage across resource components such as CPU, GPU, and storage. End users can export this usage data in PDF, CSV, and XLSX formats. Access to information varies by user role: project members can see details for their specific projects, while organization owners can view information for all projects within their organization.

In addition to that, Waldur offers convenient way for exporting the usage information for visualization with Grafana.

Checklist for Go live

General

  • Make sure that privacy policy and terms of use are updated to the site specific ones.
  • Make sure that SMTP server and outgoing email address are configured and emails are sent out.
  • Reboot test: restart all the nodes where Waldur components are running, application should recover automatically.

Security

  • Remove or disable default staff accounts.
  • Generate a new random secret key.

Backups

  • Make sure that configuration of Waldur is backed up and versioned.
  • Assure that DB backups are performed, i.e. backups are created when manually triggering
  • Assure that DB backups files are on a persistent storage, preferably outside the storage used for Waldur's database.

Air-gapped deployments

  • Make sure that Waldur docker images are mirrored to a local registry.

Cookie policy and Telemetry

Waldur can save data about the user in a browser. Data type and policy depends on the component.

  • Saving of the latest view point of the user.
  • Saving redirect information, i.e. where to forward from a certain state.
  • Saving which authentication method was used by user for logging in.
  • Saving user session token.
  • Saving user language preference.
  • Saving authentication token (cookie) when a user logs into /admin management interface.

Waldur can send telemetry metrics to the telemetry server. Metrics are sent only if the feature is enabled and the telemetry server is configured in the Waldur settings. To toggle the feature on or off, navigate to Administration -> Settings -> Features in HomePort and enable or disable the Send telemetry metrics feature.

An example of telemetry metrics is shown below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
Deployment ID: 0f115db062b7c0dd030b16878c7
Deployment type: other
Helpdesk backend: zammad
Helpdesk integration status: true
Number of users: 1555
Number of offerings: 796
Types of offering:
    Waldur.RemoteOffering
    Marketplace.Booking
    Marketplace.Rancher
    OpenStack.Volume
    VMware.VirtualMachine
    Marketplace.Basic
Version: 6.6.5+3.g6491c9dab.dirty
Installation date: 2022-06-10 11:28:50.585100+0000

Debugging guide for Waldur Mastermind

Introduction

This guide provides systematic approaches for troubleshooting Waldur Mastermind deployments. Use these techniques to diagnose issues with API, worker processes, email delivery, and resource provisioning.

Common debugging scenarios

Symptom-based troubleshooting guide

Symptom First Check Next Steps
Users not receiving emails Email logs SMTP configuration, email templates
API returning errors API logs HTTP status codes, request parameters
Resources stuck in provisioning Worker logs Backend connectivity, quota issues
Slow performance Database logs Query performance, connection pooling
Authentication failures API logs with auth filter IdP configuration, token issues

Accessing and filtering logs

Docker Compose

Check your specific deployment logs location, typically:

1
2
3
4
# Find log location first
docker inspect waldur-mastermind-worker | grep LogPath
# Then view logs
cat /var/lib/docker/containers/[container-id]/[container-id]-json.log | grep -i "about to send"

Helm

1
2
# Replace 'waldur' with your namespace if different
kubectl logs -n waldur -l app=waldur-mastermind-worker --tail=1000 | grep -i "about to send"

Component logs

API Logs in Helm

1
2
# Replace 'waldur' with your namespace if different
kubectl logs -n waldur -l app=waldur-mastermind-api --tail=100

Worker Logs in Helm

1
2
# Replace 'waldur' with your namespace if different
kubectl logs -n waldur -l app=waldur-mastermind-worker --tail=100

Advanced log filtering

1
2
3
4
5
6
7
8
# Find errors in API logs (replace namespace if needed)
kubectl logs -n waldur -l app=waldur-mastermind-api --tail=1000 | grep -i "error\|exception"

# Track specific request by UUID
kubectl logs -n waldur -l app=waldur-mastermind-api --tail=1000 | grep "request-uuid-here"

# View all logs for a specific user (be careful with sensitive information)
kubectl logs -n waldur -l app=waldur-mastermind-api --tail=1000 | grep "user@example.com"

Troubleshooting component issues

API server problems

  1. Check if the API container is running:
1
2
3
4
5
# Docker Compose
docker ps | grep waldur-mastermind-api

# Kubernetes (replace namespace if needed)
kubectl get pods -n waldur -l app=waldur-mastermind-api
  1. Verify API health endpoint:
1
2
# Use appropriate authentication if required
curl https://your-waldur-instance/health-check/
  1. Check for configuration issues:
1
2
3
4
5
# Docker Compose
docker exec -it waldur-mastermind-api cat /etc/waldur/override.conf.py

# Kubernetes (replace namespace if needed)
kubectl -n waldur get configmap api-override-config -o yaml

Worker issues

  1. Check Celery worker status:
1
2
3
4
5
# Docker Compose
docker exec -it waldur-mastermind-worker celery -A waldur_core.server inspect active

# Kubernetes (replace namespace if needed)
kubectl -n waldur exec -it $(kubectl -n waldur get pods -l app=waldur-mastermind-worker -o name | head -1) -- celery -A waldur_core.server inspect active
  1. Verify task queue connectivity:
1
2
3
4
5
# Docker Compose
docker exec -it waldur-mastermind-worker celery -A waldur_core.server inspect ping

# Kubernetes (replace namespace if needed)
kubectl -n waldur exec -it $(kubectl -n waldur get pods -l app=waldur-mastermind-worker -o name | head -1) -- celery -A waldur_core.server inspect ping

Database troubleshooting

  1. Check database connectivity:
1
2
3
4
5
# Docker Compose - if you have direct access
docker exec -it waldur-mastermind-api waldur shell -c "from django.db import connection; connection.ensure_connection(); print('Connected')"

# Kubernetes (replace namespace if needed)
kubectl -n waldur exec -it $(kubectl -n waldur get pods -l app=waldur-mastermind-api -o name | head -1) -- waldur shell -c "from django.db import connection; connection.ensure_connection(); print('Connected')"
  1. Identify slow queries (requires database access rights):
1
2
3
4
5
-- For PostgreSQL 9.6+
SELECT pid, now() - pg_stat_activity.query_start AS duration, query 
FROM pg_stat_activity 
WHERE state = 'active' AND now() - pg_stat_activity.query_start > interval '5 seconds'
ORDER BY duration DESC;

API endpoint issues

  1. Test endpoint with curl (store tokens in environment variables for security):
1
2
3
4
5
# Set token in environment variable first
export WALDUR_TOKEN="your_token_here"

# Then use it safely
curl -v -H "Authorization: Token $WALDUR_TOKEN" https://your-waldur-instance/api/customers/
  1. Common HTTP status codes:
  2. 401/403: Authentication/authorization issue
  3. 404: Resource not found

  4. 500: Server error (check logs)

  5. For development environments only (⚠️ NEVER in production): Temporarily increase debug verbosity through admin settings panel or by editing configuration files.

Authentication problems

  1. Check token validity:
1
2
3
4
5
# Docker Compose
docker exec -it waldur-mastermind-api waldur shell -c "from rest_framework.authtoken.models import Token; print(Token.objects.filter(key='your_token_here').exists())"

# Kubernetes (replace namespace if needed)
kubectl -n waldur exec -it $(kubectl -n waldur get pods -l app=waldur-mastermind-api -o name | head -1) -- waldur shell -c "from rest_framework.authtoken.models import Token; print(Token.objects.filter(key='your_token_here').exists())"
  1. Verify IdP configuration:
1
2
# For SAML2 configuration (replace namespace if needed)
kubectl -n waldur get configmap waldur-saml2-conf-config -o yaml

Resource provisioning failures

  1. Check resource state:
1
2
3
4
5
# Docker Compose
docker exec -it waldur-mastermind-api waldur shell -c "from waldur_mastermind.marketplace import models; print(models.Resource.objects.filter(uuid='RESOURCE_UUID').values('state', 'error_message'))"

# Kubernetes (replace namespace if needed)
kubectl -n waldur exec -it $(kubectl -n waldur get pods -l app=waldur-mastermind-api -o name | head -1) -- waldur shell -c "from waldur_mastermind.marketplace import models; print(models.Resource.objects.filter(uuid='RESOURCE_UUID').values('state', 'error_message'))"
  1. Check backend connectivity (if you have the right plugin installed):
1
2
# For OpenStack
kubectl -n waldur exec -it $(kubectl -n waldur get pods -l app=waldur-mastermind-api -o name | head -1) -- waldur shell -c "from waldur_openstack.openstack import models; tenant = models.Tenant.objects.first(); print('No tenants found' if not tenant else tenant.get_backend().verify_connection())"

Log management

Log rotation

Both Docker Compose and Kubernetes deployments typically have configured log rotation:

1
2
3
4
5
# Check Docker log rotation configuration
docker info | grep "Logging Driver"

# For Kubernetes, it depends on your cluster configuration
kubectl -n waldur describe pod $(kubectl -n waldur get pods -l app=waldur-mastermind-api -o name | head -1)

Centralized logging

For production deployments, consider:

  • Fluentd for log collection
  • Elasticsearch for storage and search
  • Kibana for visualization

Debug mode activation

⚠️ Warning: Debug mode should ONLY be used in development environments.

For development deployments, you can enable debug mode:

1
2
3
# In values.yaml
waldur:
  debug: true

For production troubleshooting, use targeted logging instead of enabling full debug mode.

Grafana and Prometheus Metrics

Waldur Homeport includes a number of reports, but for cases when additional custom reports need to be created, it is possible to setup a time-series database, for example, Prometheus, and setup business metrics exporter for Waldur.

This would allow to create live dashboards exposing, for example, growth of adoption of the platform in terms of users and offerings, aggregated costs of resource on a daily or weekly basis, total active provisioned resources on an hourly basis and so on.

To achieve that, waldur-prometheus-exporter needs to be setup. In addition, we provide example Grafana dashboard json for visualising the metrics.

Creating a database user with restricted permissions

When integrating Grafana with Waldur's database, we will create a dedicated database user with restricted permissions. For this, run the following commands using psql under your Waldur database user:

1
2
3
4
5
CREATE USER postgres_stats WITH PASSWORD 'password';

GRANT SELECT ON ALL TABLES IN SCHEMA public TO postgres_stats;

ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO postgres_stats;

When setting up Grafana, use the postgres_stats user to connect to your database with the appropriate permissions.

Prometheus metrics

Prometheus exporter allows to setup export of business metrics and reporting information at the fine-grained granularity, for example, every 5 minutes or daily. Collected information can then be visualized in Grafana or other visualisation solutions.

Currently, the following metrics are supported:

  • Total count of users;
  • Total count of organizations;
  • Total count of projects;
  • Total count of users with owner permissions;
  • Total count of support users;
  • Total count of users with local registration method;
  • Total count of users with saml2 registration method;
  • Total count of users with tara registration method;
  • Total count of users with eduteams registration method;
  • Total count of active resources;
  • Count of projects for each organization;
  • Count of resources for every organization;
  • Count of members for every organization;
  • Resources limits by offerings, customer groups, customer countries;
  • Aggregated usages by offerings, customer groups, customer countries;
  • Aggregated usages per month;
  • Count of users visible to service provider;
  • Count of projects visible to service provider;
  • Count of projects visible to service provider and grouped by OECD science code;
  • Total cost of active resources per offering;
  • Projects usages grouped by OECD science code;
  • Projects limits grouped by OECD science code;
  • Projects usages grouped by industry flag;
  • Projects limits grouped by industry flag;
  • Count unique users connected with active resources of a service provider;
  • Count active resources grouped by offering;
  • Count active resources grouped by country;
  • Count active resources grouped by organization group;
  • Count projects with active resources grouped by provider and OECD science code;
  • Count projects with active resources grouped by provider and industry flag.

Hardware Requirements

This document outlines the recommended hardware requirements for deploying Waldur in different environments.

Deployment Methods

Deployment Method Minimum Requirements Recommended Configuration Notes
Docker Compose • 4 vCPU
• 12 GB RAM
• 20 GB storage		 • 8 vCPU
• 16 GB RAM
• 40 GB storage		 Single server deployment, fastest to set up
Kubernetes (Helm) See detailed component breakdown below See detailed component breakdown below Production-grade, scalable deployment

Kubernetes Resource Requirements

Namespace Totals

Requirement Level CPU Memory Storage Notes
Minimal 10000m (10 vCPU) 18000Mi (18 GB) 32Gi 1 replica per each Waldur component, 1 PostgreSQL, 1 RabbitMQ + room for updates (3 vCPU, 2 GB)
Recommended 22000m (22 vCPU) 45000Mi (45 GB) 185Gi 2 Waldur Mastermind API, 2 Waldur Workers, 1 Waldur Beat, 1 Waldur Homeport, 3 PostgreSQL HA replicas, 3 RabbitMQ replicas + room for updates (3 vCPU, 8 GB)

Per-Component Requirements

Component CPU Requests CPU Limits Memory Requests Memory Limits Notes
Waldur Mastermind API 500m 1000m 2000Mi 4000Mi Serves API requests, increase for high traffic
Waldur Mastermind Worker 1000m 2000m 2000Mi 4000Mi Processes background tasks, critical for performance
Waldur Mastermind Beat 250m 500m 500Mi 1000Mi Schedules periodic tasks
Waldur HomePort 250m 500m 500Mi 1000Mi Serves web interface
PostgreSQL (Single) 500m 1000m 1024Mi 2048Mi Main database, persistent storage
PostgreSQL (HA, per replica) 1000m 2000m 2048Mi 4096Mi For high availability (3 replicas recommended)
RabbitMQ (per replica) 1000m 2000m 2048Mi 4096Mi Message broker (3 replicas recommended)

Storage Requirements

Component Minimal Size Recommended Size Notes
PostgreSQL 10Gi 40Gi Main database storage, grows with user and resource count
RabbitMQ 2Gi 5Gi Message queue persistence
Backups 20Gi 50Gi Separate storage for database backups

Scaling Recommendations

User Scale API Replicas Worker Replicas PostgreSQL Configuration Additional Notes
Small (<100 users) 1 1 Single instance Default values sufficient
Medium (100-500 users) 2 2 Single instance with increased resources Enable HPA for API
Large (500+ users) 3+ 3+ HA with 3 replicas Enable HPA for all components, increase resource limits

Performance Factors

Consider increasing resources beyond the recommended values if your deployment includes:

  • High number of concurrent users (>50 simultaneous active sessions)
  • Large number of resources being managed (>1000 total resources)
  • Complex marketplace offerings with many components
  • Frequent reporting or billing operations
  • Integration with multiple external systems

Hardware Recommendations for Production

Component vCPU RAM Storage Network
Control Plane Nodes 4 cores 8 GB 100 GB SSD 1 Gbps
Worker Nodes 8 cores 16 GB 200 GB SSD 1 Gbps
Database Nodes 4 cores 8 GB 100 GB SSD 1 Gbps
Load Balancer 2 cores 4 GB 20 GB 1 Gbps

Managing Waldur with Ansible

NB! Repository with Ansible playbooks for Waldur management is not open-sourced. It is available to Waldur users that have purchased support packages.

Compatibility

Ansible version 2.9 is supported; code in this repository may work with other Ansible versions but it is not guaranteed.

Quick setup

  1. Make sure that you have:
    • Folder containing managed-ansible Ansible installer (this one).
    • Folder containing deployment-specific settings.
  2. Copy setup_deployment.sh.example to setup_deployment.sh, adjust:
    • INSTALLER_PATH - full path to current folder
    • DEPLOYMENT_CONFIG_PATH - full path to folder with deployment-specific information
    • DEPLOYMENT_IDS - list of deployment IDs you want to manage.
  3. Run ./setup_deployment.sh. This will create required symlinks.
  4. Run ansible-playbook -DC <deployment_id.yml> to check what installer will do.
  5. Run ansible-playbook -D <deployment_id.yml> to apply the installer.

Upgrading installer

  1. Download a new archive into a separate folder and unpack.

  2. Check what has changed:

    rsync --dry-run -avzh unpacked-folder-eg-ansible-3.2.3/ /path/to/installer/

  3. Do the upgrade:

    rsync -avzh unpacked-folder-eg-ansible-3.2.3/ /path/to/installer/

Upgrading Waldur

Upgrading Waldur to a new version is achieved by following the checklist:

  1. Update deployment-specific variables for the new version in groups_vars/<deployment_id>/vars and groups_vars/<deployment_id>/vault (if setting is private).
  2. Update target version in groups_vars/<deployment_id>/vars: set waldur_homeport_version and waldur_mastermind_version to a new version of the Waldur release.
  3. Run ansible-playbook -DC <deployment_id.yml> to check what installer will do during the upgrade.
  4. Run ansible-playbook -D <deployment_id.yml> to perform an upgrade.

Add new deployment

Infrastructure:

  1. Prepare servers matching requirements.
  2. Make sure you can access them by SSH by running only ssh <host>. Otherwise you should tweak ~/.ssh/config file or describe connectivity in the Ansible inventory.

Ansible (this repository):

  1. Add new deployment-specific host group to hosts file (example: [foo]); add hosts to this group.
  2. Add hosts to Waldur role groups in hosts file.
  3. Add variable files for new deployment: group_vars/foo/vars and group_vars/foo/vault
  4. Add deployment specific information under deployments folder.
  5. Copy existing playbook that is the closest match for a new deployment; modify as needed
  6. Run Ansible playbook to set up deployment: ansible-playbook -D foo.yml

Remove deployment

Ansible (this repository):

  1. Delete deployment-specific playbook, roles, tasks, templates etc.
  2. Delete variable files: rm -rf group_vars/foo
  3. Delete deployment-specific host group and all deployment-specific hosts from hosts file (example: [foo])

Managing Waldur deployed as Helm

Requirements:

  1. Installed and running kubernetes system on a node (e. g. minikube)
  2. Installed kubectl on the node

Place all configuration files for release in next manner:

  • values.yaml -> roles/waldur_helm/files/waldur_helm/waldur/
  • values.yaml -> roles/waldur_helm/files/waldur_helm/waldur/
  • Files related to TLS -> deployments/<deployment_id>/tls/
  • Files related to white-labeling -> deployments/<deployment_id>/whitelabeling/
  • Files related to mastermind templates -> deployments/<deployment_id>/mastermind_templates/
  • Files related to stress testing -> deployments/<deployment_id>/locust_tasks/
  • Files related to SAML2 -> deployments/<deployment_id>/waldur_saml2/

More configuration info:

Multilingual User Interface

Waldur user interface is available in several languages. Default language is English, but the end users may have several other options to choose from. The number of available languages depends on the Waldur's configuration. Current status of the overall avalable languages are visible on the Localazy website.

Waldur uses Localazy service, to translate the user interface. Localazy is a continuous localization platform and web-based translation management system. This allows to use AI or human translation. Everyone can contribute to Waldur's translation by adding new translantions or fixing current ones, more information here.

OfferingUser management

OfferingUser is a model in Waldur, which represents a link between an offering available in marketplace and a user. A service provider can utilize it to create an account for a service visible for all the offering resources, for example: a user account in a SLURM cluster. As an account, an OfferingUser can have a custom username different from user's one.

This feature is available for all offering types.

For Basic, SLURM remote and Custom script offerings, offering-users are created automatically when a user is added to the project with active offering resources or when a new offering resource is created.

In case of Rancher, offering-users are created when users are imported from a Rancher cluster.

In case of SLURM, offering-users are created when association are imported from a SLURM cluster.

Defining the OfferingUser management policy

A service provider can define the policy via User Interface:

  1. Select the particular offering and go to Edit section.

  2. Select Integration and then User management from the top menu.

    OfferingUser management

  3. Here it is possible to enable the automatic creation of offering users and define how it is done exactly.

    • Enable automatic creation of offering users: Enable/disable automatic creation of offering users;
    • Shared user password: Set common password for all offering users;

    • Username generation policy: Define how usernames are generated:

      • Service provider: a service provider should manually set usernames for the offering users (default strategy);
      • Anonymized: usernames are generated with <prefix>_<number>, e.g. "anonym_00001"; the prefix must be specified in the plugin options of the offering as username_anonymized_prefix;
      • Full name: usernames are constructed using first and last name of users with numerical suffix, e.g. "john_doe_01";
      • Waldur username: uses a Waldur instance username of a user;
      • FreeIPA: uses the username field of a corresponding FreeIPA profile;
      • Identity claim: uses dedicated attribute released by the IdP as a username.

    • Initial UID number: refers to the lowest numerical user ID (UID) assigned to regular users;

    • Initial primary group number: refers to Group ID (GID) assigned to a user when they are created;
    • Home directory prefix: Allows to define home directory prefix for the offering users.

  4. After this, the usernames are regenerated for all the linked offering users.

Granting user access to resource

An access to a resource can be granted by service provider for a particular user with specification of username. A result is represented by triplet [user, resource, username]. For this purpose, create_remote_offering_user should be invoked. This method requires the following arguments:

  • offering - UUID or URL of a target offering;
  • user - UUID or URL of a target user;
  • username - username for the user.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
  result = client.create_remote_offering_user(
      offering='<offering-uuid-or-url>',
      user='<user-uuid-or-url>',
      username='<username>'
  )

  # result => {
  #  'created': '2021-08-12T15:22:18.993586Z',
  #  'offering': 'http://localhost:8000/api/marketplace-provider-offerings/d47ca5bce71144579df29da3c290027e/',
  #  'offering_name': 'Remote offering (really)',
  #  'offering_uuid': 'd47ca5bce71144579df29da3c290027e',
  #  'user': 'http://localhost:8000/api/users/db157a5cf7f247eba161cd90eba9ac63/',
  #  'user_uuid': 'db157a5cf7f247eba161cd90eba9ac63',
  #  'username': 'abc'
  # }

In case if SDK usage is not possible, HTTP request can be sent:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
  POST <API-URL>/marketplace-offering-users/

  {
      "offering": "<offering-uuid-or-url>",
      "user": "<user-uuid-or-url>",
      "username": "<username>"
  }

  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

  {
      "created": "2021-08-12T15:22:18.993586Z",
      "offering": "http://localhost:8000/api/marketplace-provider-offerings/d47ca5bce71144579df29da3c290027e/",
      "offering_name": "Remote offering (really)",
      "offering_uuid": "d47ca5bce71144579df29da3c290027e",
      "user": "http://localhost:8000/api/users/db157a5cf7f247eba161cd90eba9ac63/",
      "user_uuid": "db157a5cf7f247eba161cd90eba9ac63",
      "username": "abc"
  }

Granting user access to corresponding resources in batch manner

A service provider can grant access mentioned in the previous section to all resources used in projects including a target user. For such access creation or update, set_offerings_username is used. The method requires the following arguments:

  • service_provider_uuid - UUID of a target service provider;
  • user_uuid - UUID of a target user;
  • username - the new username.
1
2
3
4
5
6
7
8
9
  result = client.set_offerings_username(
      service_provider_uuid='<service-provider-uuid>',
      user_uuid='<user-uuid>',
      username='<username>',
  )

  # result =>  {
  #  'detail': 'Offering users have been set.'
  # }

Waldur roles and permissions

Overview

Waldur provides a flexible Role-Based Access Control (RBAC) system, enabling administrators to manage user permissions efficiently. Roles define the actions users can perform within the system, ensuring structured and secure access to resources.

This guide outlines Waldur's roles, their associated permissions, and how they govern access within the platform.

Managing roles in Waldur

Roles in Waldur are structured to define user access within specific scopes. The key attributes of a role include:

  • Name – A unique identifier for the role
  • Scope – The context in which the role is applicable (e.g., Organization, Project, Call, etc.)
  • Description – A brief explanation of the role's purpose and responsibilities
  • Active – Indicates whether the role is currently available for assignment

Users can be assigned one or more roles within an Organization, Project, Call, Offering, Service Provider, Proposal, or Call managing organization scope.

Default roles and permissions

Waldur provides predefined roles to streamline access management across different scopes. Below is an overview of available roles, grouped by scope.

Organization roles

Scope: Organization

Name Description Active
Customer owner The highest-level role in an organization, granting full administrative control Yes
Customer manager A managerial role for service providers within an organization Yes
Customer support Provides limited support access within an organization No

Project roles

Scope: Project

Name Description Active
Project administrator Grants full control over a project, including resource and order management Yes
Project manager Similar to the administrator role but includes additional permission management capabilities Yes
Project member A limited role with basic project access No

Offering roles

Scope: Offering

Name Description Active
Offering manager Manages an offering's configuration and associated resources Yes

Call managing organization roles

Scope: Call managing organization

Name Description Active
Customer call organizer An organization-specific role for handling calls Yes

Call roles

Scope: Call

Name Description Active
Call manager Oversees calls and proposal approvals Yes
Call reviewer A role dedicated to reviewing submitted proposals Yes

Proposal roles

Scope: Proposal

Name Description Active
Proposal manager Responsible for managing proposals within a call Yes

Service provider roles

Scope: Service provider

Name Description Active
Service provider manager Manages service provider-specific settings and operations Yes

Role assignment and management

Roles are assigned to users based on their responsibilities and required access levels. Administrators can:

  • Add or remove user roles
  • Modify permissions associated with roles
  • Revoke roles manually or set expiration times for temporary access

Managing roles via the interface

The Waldur administration interface offers an intuitive way to manage user roles. Staff users can:

  1. Navigate to the Administration panel
  2. Select the User roles section under Settings menu
  3. Modify existing roles by updating permissions or changing their status
  4. Disable roles as needed

Using the administration interface simplifies role management and ensures a structured approach to access control.

⚠️ Important notes:

  • Roles should follow the principle of least privilege
  • Some roles are disabled by default (e.g., Customer support)
  • Regular audits of role assignments are recommended
  • Certain roles are scope-restricted (e.g., Customer call organizer)
  • Changes to role permissions should be carefully considered
  • Document any custom role configurations

Waldur Shell

Waldur provides a shell for command line scripting. To start a shell, run waldur shell in the MasterMind context.

For Docker Compose deployments, please run:

docker exec -it waldur-mastermind-api waldur shell

For Helm-based K8s deployments, please run:

1
2
3
export KUBECONFIG=/etc/rancher/rke2/rke2.yaml  # if running from RKE2 node
kubectl get pods -A | grep waldur-mastermind-worker  # to find POD id
kubectl exec --stdin --tty waldur-mastermind-worker-POD-ID -- waldur shell

Examples

Setting/removing staff permissions for a user

1
2
3
4
5
6
7
8
from waldur_core.core.models import User

user = User.objects.get(
    username="example_user",
)
user.set_password("somesecretpassword")
user.is_staff = True  # set to False if you want to remove permission
user.save()

Creating a new user with token only authentication

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from rest_framework.authtoken.models import Token
from waldur_core.core.models import User

user = User.objects.create(
    username="example_accounting_user",
    first_name="Accounting",
    last_name="Reporter",
    email="test@example.com",
)
user.token_lifetime = None
user.set_unusable_password()
user.save()

token = Token.objects.get(user=user)
print(token)

Triggering pulling of usage data from remote Waldur

1
2
3
from waldur_mastermind.marketplace_remote.tasks import UsageListPullTask

UsageListPullTask().run()

Apply changes in Waldur HPC plugin to existing users

1
2
3
4
5
from waldur_core.core import models as core_models
from waldur_hpc.handlers import handle_new_user

for user in core_models.User.objects.filter(is_active=True, registration_method__iexact='saml2'):
    handle_new_user(None, user, created=True)

Cleanup leftover ports from OpenStack Project

Lookup UUID of an OpenStack tenant (aka backend_id in Waldur).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_openstack.models import Tenant

t_uuid = 'UUID_OF_TENANT'
t = Tenant.objects.get(backend_id=t_uuid)

nc = t.get_backend().neutron_client
all_ports = nc.list_ports()['ports']
tenant_ports = [port for port in all_ports if port['tenant_id'] == t_uuid and port.get('status') == 'DOWN']

for t in tenant_ports:
    print(t['id'], t['fixed_ips'][0]['ip_address'])
    nc.delete_port(t['id'])

Add affiliations to user

1
2
3
4
5
from waldur_core.core import models as core_models

user = core_models.User.objects.get(email='some.email@abc.example.com')
user.affiliations = ['some.affiliation@domain.example.com']
user.save()

Create a service user for API access

To create a service user - without valid access credntials and non-expiring Token, please run the following script.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_core.core.models import User

u = User.objects.create(username='waldur_demo_user', first_name='Demo',
                        last_name='Waldur user', email='demo@example.com')

# make sure that token doesn't time out
u.token_lifetime = None
u.save()

# print user authentication token
print(u.auth_token.key)

Synchronise SLURM associations

Note: <allocation-uuid> field can be found in an allocations's details page.

Select Organization -> Select project -> Select allocation -> Find 'UUID' field in the page.

1
2
3
4
5
6
7
8
from waldur_slurm import models as slurm_models

allocation = slurm_models.Allocation.objects.get(uuid='<allocation-uuid>')
backend = allocation.get_backend()

backend.add_new_users(allocation) # Creates associations on SLURM level

backend.pull_allocation(allocation) # Sync associations on Waldur level

Lookup user details from Eduteams

Note: USER_CUID is a unique ID of user in Eduteams.

1
2
3
4
5
from waldur_auth_social.utils import get_remote_eduteams_user_info

USER_CUID='semi_secret@eduteams.org'

get_remote_eduteams_user_info(USER_CUID)

Generate report for list of projects and their details

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import sys
import csv

from waldur_core.structure import models as structure_models


projects = structure_models.Project.objects.filter(created__lte='2022-05-31')
writer = csv.writer(sys.stdout)
for project in projects:
    owner = project.customer.get_owners().first()
    writer.writerow(
        [
            project.name,
            owner and owner.full_name,
            project.oecd_fos_2007_code,
            project.customer.country,
        ]
    )

Generate report for OpenStack resources across projects

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import csv
import sys

from waldur_openstack.models import Tenant, Instance, Volume
from waldur_core.structure.models import ServiceSettings

RAM_LIMIT_NAME = 'ram'
STORAGE_LIMIT_NAME = 'storage'

writer = csv.writer(sys.stdout)


def generate_report():
    tenants = Tenant.objects.filter(state=3)
    writer.writerow(
        [
            'Organisation',
            'Abbreviation',
            'Project',
            'VPC',
            'RAM limit',
            'RAM usage',
            'Storage limit',
            'Storage usage',
            'Number of VMs',
            'Big VM count',
            'Big volume count',
        ]
    )
    for tenant in tenants:
        number_of_vms = tenant.quotas.get(name='instances').usage
        ram_limit = tenant.quotas.get(name='ram').limit / 1024
        ram_usage = tenant.quotas.get(name='ram').usage / 1024
        storage_limit = tenant.quotas.get(name='storage').limit / 1024
        storage_usage = tenant.quotas.get(name='storage').usage / 1024
        # RAM > 16 GB
        big_vm_count = Instance.objects.filter(tenant=tenant, ram__gt=16 * 1024).count()
        # Disk > 256 GB
        big_storage_count = Volume.objects.filter(tenant=tenant, size__gt=256 * 1024).count()
        writer.writerow(
            [
                tenant.project.customer.name,
                tenant.project.customer.abbreviation,
                tenant.project.name,
                tenant,
                ram_limit,
                ram_usage,
                storage_limit,
                storage_usage,
                number_of_vms,
                big_vm_count,
                big_storage_count,
            ]
        )

Update limits for all tenants in a specific organization

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
from waldur_api_client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_list
from waldur_api_client.api.marketplace_resources import marketplace_resources_update_limits
from waldur_api_client.models import ResourceUpdateLimitsRequest

WALDUR_API_URL = '<CHANGEME>'
WALDUR_API_TOKEN = '<CHANGEME>'
CUSTOMER_UUID = '<CHANGEME>'

CORES_LIMIT = 1
RAM_GB_LIMIT = 10
STORAGE_GB_LIMIT = 100

TENANT_LIMITS = {
    'cores': CORES_LIMIT,
    'ram': RAM_GB_LIMIT * 1024,
    'storage': STORAGE_GB_LIMIT * 1024
}

client = AuthenticatedClient(
    base_url="https://api.example.com",
    token="SuperSecretToken",
)

tenants = openstack_tenants_list.sync(
    client=client,
    customer_uuid=CUSTOMER_UUID
)

for tenant in tenants:
    marketplace_resources_update_limits.sync(
        client=client,
        uuid=tenant.marketplace_resource_uuid,
        body=ResourceUpdateLimitsRequest(limits=TENANT_LIMITS)
    )

Generate cost report for a specific organization by month

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import sys
import csv

from waldur_core.structure import models as structure_models
from waldur_mastermind.invoices import models as invoice_models

customer = structure_models.Customer.objects.get(abbreviation='Ada')
invoices = invoice_models.Invoice.objects.filter(customer=customer).order_by('year', 'month')
writer = csv.writer(sys.stdout)
for invoice in invoices:
    writer.writerow(
        [
            invoice.year,
            invoice.month,
            invoice.state,
            invoice.price,
            invoice.tax,
            invoice.total,
        ]
    )

Generate a report for VMs created within a specific tenant offering

Upon running the script, please change year and offering_uuid variables.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
from waldur_mastermind.marketplace import models as mm
from urllib.parse import urlparse
from waldur_openstack import models as otm
import csv

year = 2024
offering_uuid = "changeme"

tenant_offering = mm.Offering.objects.get(uuid=offering_uuid)

vm_orders = mm.Order.objects.filter(
    offering__parent=tenant_offering,
    state=mm.Order.States.DONE,
    type=mm.Order.Types.CREATE,
    resource__created__year=year,
).order_by("created")

report = []

for order in vm_orders:
    resource = order.resource
    flavor_url = resource.attributes.get("flavor")

    if flavor_url is None:
        print("flavor_url is missing for order %s" % order)
        continue

    flavor_parsed_url = urlparse(flavor_url)
    flavor_url_parts = flavor_parsed_url.path.split("/")
    flavor_uuid = flavor_url_parts[-2]
    flavor = otm.Flavor.objects.filter(uuid=flavor_uuid).first()

    if flavor is None:
        print("There is no flavor for order %s" % order)
        continue

    system_volume_size = order.attributes["system_volume_size"]
    data_volume_size = resource.attributes.get("data_volume_size", 0)

    vm_terminated = ""
    if resource.state == mm.Resource.States.TERMINATED:
        termination_order = mm.Order.objects.filter(
            resource=resource, state=mm.Order.States.DONE, type=mm.Order.Types.TERMINATE
        ).first()

        if termination_order is None:
            print("Termination order for resource %s does not exist" % resource)
        else:
            vm_terminated = termination_order.consumer_reviewed_at.isoformat()

    report.append(
        {
            "vm_name": resource.name,
            "vm_created": resource.created.isoformat(),
            "vm_terminated": vm_terminated,
            "project_name": resource.project.name,
            "flavor_name": flavor.name,
            "flavor_cores": flavor.cores,
            "flavor_ram": flavor.ram,
            "flavor_disk": flavor.disk,
            "system_volume_size": system_volume_size,
            "data_volume_size": data_volume_size,
        }
    )

report_path = f"vm-report-{year}.csv"

with open(report_path, mode="w") as file:
    fieldnames = [
        "vm_name",
        "vm_created",
        "vm_terminated",
        "project_name",
        "flavor_name",
        "flavor_cores",
        "flavor_ram",
        "flavor_disk",
        "system_volume_size",
        "data_volume_size",
    ]
    writer = csv.DictWriter(file, fieldnames=fieldnames)
    writer.writeheader()
    writer.writerows(report)

Migrate users to a new Keycloak instance

Introduction

There are 3 scripts involved:

  1. export-keycloak-user-permissions.py: exports Keycloak user data to a .yaml file in the following format:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    - username: johndoe
  email: johndoe@example.com
  full_name: John Doe
  permissions:
    - type: project
      project_uuid: bed45d99e83d4c17a5bf5908ad70554e
      role_uuid: e4130fde02474571a5166bb6742dc2d0
      project_name: "Project 01"
      role_name: "PROJECT.MANAGER"
    - type: customer
      customer_uuid: 1aaec6489ea7492cbe0401997de13653
      role_uuid: 16ec8cf8874d467d9a2c7a0c822c6b3e
      customer_name: "Organization 01"
      role_name: "CUSTOMER.OWNER"

  2. delete-keycloak-users.py: removes data about all the users from an old Keycloak instance

  3. invite-keycloak-users.py: creates and sends invitations to the user emails based on their roles in project and organizations

When you are ready to migrate users to the new Keyaloak instance:

  1. copy the script file to the waldur-mastermind-api container using docker cp or kubectl cp commands;
  2. connect to the container shell using docker exec or kubectl exec;
  3. execute the scripts sequentially using waldur shell:
1
2
3
root@waldur-mastermind-api$ waldur shell < export-keycloak-user-permissions.py
root@waldur-mastermind-api$ waldur shell < delete-keycloak-users.py
root@waldur-mastermind-api$ waldur shell < invite-keycloak-users.py

export-keycloak-user-permissions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
from waldur_core.core import models as core_models
from waldur_core.structure import models as structure_models
from waldur_core.permissions.models import UserRole
from django.contrib.contenttypes.models import ContentType
import yaml

users = core_models.User.objects.filter(is_active=True, registration_method="keycloak")

project_content_type = ContentType.objects.get_for_model(structure_models.Project)
customer_content_type = ContentType.objects.get_for_model(structure_models.Customer)
roles = []

for user in users:
    entry = {
        "username": user.username,
        "email": user.email,
        "full_name": user.get_full_name(),
        "permissions": [],
    }
    perms = UserRole.objects.filter(user=user, is_active=True)

    for permission in perms:
        if permission.content_type == project_content_type:
            project = permission.scope
            entry["permissions"].append(
                {
                    "type": "project",
                    "project_uuid": project.uuid.hex,
                    "role_uuid": permission.role.uuid.hex,
                    "project_name": project.name,
                    "role_name": permission.role.name
                }
            )

        if permission.content_type == customer_content_type:
            customer = permission.scope
            entry["permissions"].append(
                {
                    "type": "customer",
                    "customer_uuid": customer.uuid.hex,
                    "role_uuid": permission.role.uuid.hex,
                    "customer_name": customer.name,
                    "role_name": permission.role.name
                }
            )

    roles.append(entry)

with open("roles.yaml", "w+") as output:
    yaml.dump(roles, output)

delete-keycloak-users

1
2
3
4
from waldur_core.core import models as core_models

users = core_models.User.objects.filter(is_active=True, registration_method="keycloak")
users.delete()

invite-keycloak-users

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
from waldur_core.structure import models as structure_models
from waldur_core.permissions import models as permission_models
from waldur_core.users import models as user_models
from waldur_core.core.utils import get_system_robot
from waldur_core.users import tasks as user_tasks
import yaml

system_robot = get_system_robot()

user_roles = []

with open("roles.yaml", "r") as roles_file:
    user_roles = yaml.safe_load(roles_file)

for user_role in user_roles:
    email = user_role["email"]
    full_name = user_role["full_name"]

    for perm in user_role["permissions"]:
        role_name = permission_models.Role.objects.get(uuid=perm["role_uuid"]).name
        role_name_suffix = role_name.split(".")[1].lower()

        if perm["type"] == "project":
            project = structure_models.Project.objects.get(uuid=perm["project_uuid"])

            invitation, created = user_models.Invitation.objects.get_or_create(
                email=email,
                full_name=full_name,
                customer=project.customer,
                project=project,
                project_role=role_name_suffix,
                created_by=system_robot,
            )

            if not created:
                continue

            print(
                f"Inviting user {full_name} ({email}) to project {project} as {role_name_suffix}"
            )
            user_tasks.send_invitation_created(
                invitation.uuid.hex, system_robot.full_name
            )

        if perm["type"] == "customer":
            customer = structure_models.Customer.objects.get(uuid=perm["customer_uuid"])

            invitation, created = user_models.Invitation.objects.get_or_create(
                email=email,
                full_name=full_name,
                customer=customer,
                customer_role=role_name_suffix,
                created_by=system_robot,
            )

            if not created:
                continue

            print(
                f"Inviting user {full_name} ({email}) to customer {customer} as {role_name_suffix}"
            )
            user_tasks.send_invitation_created(
                invitation.uuid.hex, system_robot.full_name
            )

User deletion examples

Basic user deletion

1
2
3
4
5
6
7
8
9
from waldur_core.core.models import User

# Delete user by exact username
user = User.objects.get(username='example_username')
user.delete()

# Delete user by email
user = User.objects.get(email='username@example.com')
user.delete()

Find and delete users with partial information

1
2
3
4
5
6
7
from waldur_core.core.models import User

# Find and delete user when you only know part of the username
# Note: filter() can return multiple results, first() gets only the first match
user = User.objects.filter(username__icontains='smith').first()
if user:
    user.delete()

Find and delete user based on OfferingUser information

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_mastermind.marketplace.models import OfferingUser

# This is useful when the username of the main User comes for example from MyAcessId with a complex format, but you know information about their OfferingUser, for example their username
offering_user = OfferingUser.objects.get(username='test_user')

print(f"Found offering user: {offering_user}")

if offering_user:
    user = offering_user.user
    print(f"Found user: {user.username}")  # Verify it's the correct user
    user.delete()

⚠️ Important notes:

  • Always verify you have the correct user before deletion
  • User deletion will cascade and remove all related permissions and roles
  • For users authenticated via external providers (LDAP, SAML, etc.), this only removes the user from Waldur

Waldur Docker-compose deployment

Prerequisites

  • at least 8GB RAM on Docker Host to run all containers
  • Docker v1.13+

Prepare environment

1
2
3
4
5
# clone repo
git clone https://github.com/waldur/waldur-docker-compose.git
cd waldur-docker-compose
# setup settings
cp .env.example .env

Booting up

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# start containers
docker compose up -d

# verify
docker compose ps
docker exec -t waldur-mastermind-worker status

# Create user
docker exec -t waldur-mastermind-worker waldur createstaffuser -u admin -p password -e admin@example.com

# Create demo categories for OpenStack: Virtual Private Cloud, VMs and Storage
docker exec -t waldur-mastermind-worker waldur load_categories vpc vm storage

Waldur HomePort will be accessible on https://localhost. API will listen on https://localhost/api.

Healthcheck can be accessed on https://localhost/health-check.

Tearing down and cleaning up:

1
docker compose down

Logs

Logs emitted by the containers are collected and saved in the waldur_logs folder. You can change the location by editing environment variable (.env) and updating LOG_FOLDER value.

Known issues

When Waldur is launched for the first time, it applies initial database migrations. It means that you may need to wait few minutes until these migrations are applied. Otherwise you may observe HTTP error 500 rendered by REST API server. This issue would be resolved after upgrade to Docker Compose 1.29.

To use a custom script offering type, it should be possible to connect to /var/run/docker.sock from within the Waldur containers. If you are getting a permission denied error in logs, try setting more open permissions, for example, chmod 666 /var/run/docker.sock. Note that this is not a secure setup, so make sure you understand what you are doing.

Upgrading Waldur

1
2
docker compose pull
docker compose restart

Upgrade Instructions for PostgreSQL Images

Upgrade Script

To simplify the upgrade process, an upgrade script db-upgrade-script.sh is included in the root directory, and can be used to automate the upgrade process.

Usage Instructions

  1. Ensure the script has execution permissions:

bash chmod +x db-upgrade-script.sh

  1. Update the WALDUR_POSTGRES_IMAGE_TAG and KEYCLOAK_POSTGRES_IMAGE_TAG in the .env file to the desired versions.:

    1
2
    WALDUR_POSTGRES_IMAGE_TAG=<your_version>
KEYCLOAK_POSTGRES_IMAGE_TAG=<your_version>

  2. Run the sript:

bash ./db-upgrade-script.sh

Upgrade Prerequisites

  • Backup existing data (if needed).

Backup Commands

You can back up the database using pg_dumpall.

For Waldur DB:

1
docker exec -it waldur-db pg_dumpall -U waldur > /path/to/backup/waldur_upgrade_backup.sql

For Keycloak DB:

1
docker exec -it keycloak-db pg_dumpall -U keycloak > /path/to/backup/keycloak_upgrade_backup.sql

Shut down containers:

1
docker compose down

Note: Before upgrading PostgreSQL, please delete the pgsql folder within the project directory if it exists, as well as the keycloak_db docker volume if it exists. These were created with the previous PostgreSQL version, and they will be recreated with docker compose during upgrade.

You can remove the pgsql folder by running:

1
sudo rm -r pgsql/

To remove the keycloak_db volume, run:

1
 docker volume rm waldur-docker-compose_keycloak_db

Warning: This action will delete your existing PostgreSQL data. Ensure it is backed up before proceeding.

Upgrade Steps

  1. Update PostgreSQL Versions

    Update the WALDUR_POSTGRES_IMAGE_TAG and KEYCLOAK_POSTGRES_IMAGE_TAG in the .env file to the required versions.

    1
2
    WALDUR_POSTGRES_IMAGE_TAG=<your_version>
KEYCLOAK_POSTGRES_IMAGE_TAG=<your_version>

  2. Pull the New Images

    Pull the new PostgreSQL images:

    1
    docker compose pull

  3. Optional: Restore Data (if backups have been made)

    Start the database containers to load the dump data:

    1
    docker compose up -d waldur-db keycloak-db

    Restore the contents of the database from the dump file:

    For Waldur DB:

    1
    cat waldur_upgrade_backup.sql | docker exec -i waldur-db psql -U waldur

    For Keycloak DB:

    1
    cat keycloak_upgrade_backup.sql | docker exec -i keycloak-db psql -U keycloak

    Post-update steps

    If the new psql version is later than 14, you need to create SCRAM tokens for the existing users. For this, run the following lines, which will automatically create necessary tokens for the users.

    1
2
3
4
    export $(cat .env | grep "^POSTGRESQL_PASSWORD=" | xargs)
docker exec -it waldur-db psql -U waldur -c "ALTER USER waldur WITH PASSWORD '${POSTGRESQL_PASSWORD}';"
export $(cat .env | grep "^KEYCLOAK_POSTGRESQL_PASSWORD=" | xargs)
docker exec -it keycloak-db psql -U keycloak -c "ALTER USER keycloak WITH PASSWORD '${KEYCLOAK_POSTGRESQL_PASSWORD}';"

  4. Start containers

    Start all of the containers:

    1
    docker compose up -d

  5. Verify the Upgrade

    Verify the containers are running with the new PostgreSQL version:

    1
    docker ps -a

    Check container logs for errors:

    1
2
    docker logs waldur-db
docker logs keycloak-db

Using TLS

This setup supports following types of SSL certificates:

  • Email - set environment variable TLS to your email to register Let's Encrypt account and get free automatic SSL certificates.

Example:

1
TLS=my@email.com
  • Internal - set environment variable TLS to "internal" to generate self-signed certificates for dev environments

Example:

1
TLS=internal
  • Custom - set environment variable TLS to "cert.pem key.pem" where cert.pem and key.pem - are paths to your custom certificates (this needs modifying docker-compose with path to your certificates passed as volumes)

Example:

1
TLS=cert.pem key.pem

Custom Caddy configuration files

To add additional caddy config snippets into the caddy virtual host configuration add .conf files to config/caddy-includes/

Keycloak

Keycloak is an Identity and Access Management software bundled with waldur-docker-compose.

To create a keycloak admin account set KEYCLOAK_ADMIN env variable in docker-compose.yaml and KEYCLOAK_ADMIN_PASSWORD in .env file.

After this, you can login to the admin interface at https://localhost/auth/admin and create Waldur users.

To use Keycloak as an identity provider within Waldur, follow the instruction here. The discovery url to connect to Keycloak from the waldur-mastermind-api container is:

1
http://keycloak:8080/auth/realms/<YOUR REALM>/.well-known/openid-configuration

Integration with SLURM

The integration is described here.

Whitelabeling settings

To set up whitelabeling, you need to define settings in ./config/waldur-mastermind/whitelabeling.yaml. You can see the list of all whitelabeling options below.

General whitelabeling settings

  • site_name
  • site_address
  • site_email
  • site_phone
  • short_page_title
  • full_page_title
  • brand_color
  • hero_link_label
  • hero_link_url
  • site_description
  • currency_name
  • docs_url
  • support_portal_url

Logos and images of whitelabeling

The path to a logo is constructed like so: /etc/waldur/icons - is a path in the container (Keep it like it is) + the name of the logo file from config/whitelabeling directory.

All-together /etc/waldur/icons/file_name_from_whitelabeling_directory

  • powered_by_logo
  • hero_image
  • sidebar_logo
  • sidebar_logo_mobile
  • site_logo
  • login_logo
  • favicon

Readonly PostgreSQL user configuration

In order to enable /api/query/ endpoint please make sure that read-only user is configured both in PostgreSQL and in the environment variables.

1. Create PostgreSQL readonly user

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
-- Create a read-only user
CREATE USER readonly WITH PASSWORD '{readonly_password}';

-- Grant read-only access to the database
GRANT CONNECT ON DATABASE {database_name} TO {readonly_username};

-- Grant read-only access to the schema
GRANT USAGE ON SCHEMA public TO {readonly_username};

-- Grant read-only access to existing tables
GRANT SELECT ON ALL TABLES IN SCHEMA public TO {readonly_username};

-- Grant read-only access to future tables
ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO {readonly_username};

-- Revoke access to authtoken_token table
REVOKE SELECT ON authtoken_token FROM {readonly_username};

2. Configure environment variables

Add the following environment variables to your .env file:

1
2
POSTGRESQL_READONLY_USER={readonly_username}
POSTGRESQL_READONLY_PASSWORD={readonly_password}

Note: Replace {readonly_password} with the actual password you used when creating the readonly user, and {readonly_username} with your chosen readonly username (e.g., "readonly").

Migration from bitnami/postgresql to library/postgres DB image

After migration from the bitnami/postgresql to library/postgres DB image, you might notice a working in logs like this:

1
2
3
4
...
WARNING:  database "waldur" has a collation version mismatch
DETAIL:  The database was created using collation version 2.36, but the operating system provides version 2.41.
...

In this case, you can simply update the collaction version and reindex the Waldur DB and the public schema:

1
2
3
4
5
6
7
8
9
-- Run these commands in the psql shell of the waldur-db container

ALTER DATABASE waldur REFRESH COLLATION VERSION;
ALTER DATABASE postgres REFRESH COLLATION VERSION;
ALTER DATABASE celery_results REFRESH COLLATION VERSION;
ALTER DATABASE template1 REFRESH COLLATION VERSION;

REINDEX DATABASE waldur;
REINDEX SCHEMA public;

Waldur deployment in ArgoCD

This repository contains ansible playbook settings for infrastructure setup (ansible/ directory) together with Kubernetes manifest files for different applications managed by ArgoCD (applications/ directory).

Infrastructure setup

Before beginning with application management, infrastructure setup is required. For this, you should use the playbook ansible/cloud-infrastructure-setup.yaml. Given an access to virtual machines with python3.8+ installed, it is capable of:

  1. Disk setup in case if each virtual machine has a separate disk attached as a device;
  2. Installation of RKE2-managed Kubernetes cluster with a single server and workers;
  3. Installation of Helm tool binary;
  4. Installation of ArgoCD: both Kubernetes manifests and command-line binary.

All these steps can be customized via either ansible/vars.defaults or ansible/vars.custom file.

The example infra has 3 VMs with python3.9 installed. After establishing ssh-based connection to the machines, you can execute the playbook:

1
ansible-playbook -i hosts -D cloud-infrastructure-setup.yaml

After successful run, the infra is ready for further steps.

Installation and management of applications

You should run all the command described below on the RKE2 server, where ArgoCD binary installed, only.

Prerequisite

The following lines ensure user login to ArgoCD server via argocd binary. They should run prior to every application-related action.

1
2
3
ARGOCD_SERVER_IP=$(kubectl get service argocd-server -n argocd -o jsonpath={.spec.clusterIP})
ARGOCD_ADMIN_PASSWORD=$(argocd admin initial-password -n argocd | head -n1)
argocd login $ARGOCD_SERVER_IP:80 --username admin --password $ARGOCD_ADMIN_PASSWORD --name default

You can validate authentication and access:

1
2
argocd account get-user-info
argocd app list

Longhorn

You can use this app manifest and this custom values file for Longhorn installation.

This script creates a new Kubernetes namespace, where application is created synched:

1
2
3
kubectl create namespace longhorn-system
argocd app create -f applications/longhorn/application.yaml
argocd app sync argocd/longhorn

PostgreSQL operator

You can use this app manifest and this custom values file for PostgreSQL operator installation.

This script creates a new Kubernetes namespace, where application is created synched:

1
2
3
kubectl create namespace postgres-operator-system
argocd app create -f applications/postgresql-operator/application.yaml
argocd app sync argocd/postgres-operator

Waldur

Waldur requires PostgreSQL database as a persistent storage and RabbitMQ as a message queue to be up and running.

Firstly, you need to create a namespace for Waldur:

1
kubectl create namespace waldur

Secondly, create and sync PostgreSQL application managed by the operator installed before. You can use this manifest for ArgoCD app and this manifest for modification of the DB settings.

1
2
argocd app create -f applications/waldur-postgresql/application.yaml
argocd app sync argocd/waldur-postgresql

Finally, you can deploy Waldur using this app manifest and these values. NB: RabbitMQ is included in the deployment.

1
2
argocd app create -f applications/waldur/application.yaml
argocd app sync argocd/waldur

Ended: Argocd

Waldur Helm

Waldur is a platform for creating hybrid cloud solutions. It allows building enterprise-grade systems and providing self-service environment for the end-users.

Introduction

This chart bootstraps a Waldur deployment on a Kubernetes cluster using the Helm package manager.

Installing prerequisites

  1. Install Kubernetes server, for example, using minikube
  2. Install Kubernetes client, i.e. kubectl
  3. Install Helm

Installing the chart

  1. Add the Waldur Helm repository

    1
      helm repo add waldur-charts https://waldur.github.io/waldur-helm/

  2. Install dependencies or enable them in Helm values

2.1. Quick setup:

1
2
3
4
5
6
7
8
9
In `values.yaml` set:
  - `postgresql.enabled` to `true`
  - `rabbitmq.enabled` to `true`

One-liner:

```bash
helm install my-waldur --set postgresql.enabled=true --set rabbitmq.enabled=true waldur-charts/waldur
```

2.2. Advanced setup of dependencies Setup database using one of: - Simple PostgreSQL DB: instructions or - PostgreSQL HA DB: instructions or - Integrate with external DB: instructions

1
2
3
  Install MinIO (for database backups): [instructions](docs/minio.md)

  Install RabbitMQ for task queue: [instructions](docs/rabbitmq.md)

  1. Install the Helm chart

    1
      helm install my-waldur waldur-charts/waldur -f path/to/values.yml

NB After this command, Waldur release will run in default namespace. Please, pay attention in which namespace which release is running.

For instance, you can install Waldur release in test namespace in the following way:

  1. Create test namespace:

    1
      kubectl create namespace test

  2. Install release:

    1
      helm install waldur waldur-charts/waldur --namespace test

However, postgresql release and waldur should be installed in the same namespace in order to share a common secret with DB credentials.

Adding admin user

Open waldur-mastermind-worker shell and execute the following command:

  1. Get waldur-mastermind-worker pod name

    1
2
3
      # Example:
  kubectl get pods -A | grep waldur-mastermind-worker # -->
  # default waldur-mastermind-worker-6d98cd98bd-wps8n 1/1 Running 0 9m9s

  2. Connect to pod via shell

    1
2
      # Example:
  kubectl exec -it deployment/waldur-mastermind-worker -- /bin/bash

  3. Execute command to add admin user

    1
      waldur createstaffuser -u user -p password -e admin@example.com

Waldur Helm chart release upgrading

Delete init-whitelabeling job (if exists):

1
  kubectl delete job waldur-mastermind-init-whitelabeling-job || true

Delete load features job (if exists):

1
  kubectl delete job load-features-job || true

Upgrade Waldur dependencies and release:

1
2
  helm dep update waldur/
  helm upgrade waldur waldur/

Restart deployments to apply configmaps changes:

1
2
3
4
  kubectl rollout restart deployment waldur-mastermind-beat
  kubectl rollout restart deployment waldur-mastermind-api
  kubectl rollout restart deployment waldur-mastermind-worker
  kubectl rollout restart deployment waldur-homeport

Private registry setup

A user can use private registry for Docker images. For this, the corresponding credentials should be registered in a secret, name of which should be placed in .Values.imagePullSecrets. A secret can be created trough CLI.

Configuration docs

Configuration documentation: index

Bootstrap configuration

You can create a bootstrapping script and Helm will run it right after Waldur release installation.

Example script:

1
2
3
4
5
6
7
8
  #!/bin/bash
  set -e

  echo "[+] Creating staff user"
  waldur createstaffuser -u admin -p admin -e admin@example.com
  echo "[+] Done"

  exit 0

This script with all necessary additional files should be placed in bootstrap.dir directory.

Additional configuration variables (bootstrap prefix):

  1. enabled - enable/disable bootstrap
  2. script - main script file in bootstrap.dir folder.
  3. dir - directory with all bootstrap files

Moreover, that is better to install release with --wait flag:

1
  helm install waldur waldur/ --wait --timeout 10m0s

This allows running migrations job before a bootstrap one. more info: link, Hooks and the Release Lifecycle section)

NB:

  • A script, which contains interaction with a db can fail due to not all migrations are applied. Automatical reruning of the bootstrap job is normal behaviour in such situations.

  • Hence, the script should be idempotent.

External DB integration

Waldur Helm can use an external PostgreSQL deployed within the same Kubernetes cluster.

For this, you need to set the following variables in values.yaml:

  1. externalDB.enabled - toggler for integration; requires postgresql.enabled and postgresqlha.enabled to be false
  2. externalDB.flavor - a type of the DB management system; currently only zalando (Zalando operator) is supported
  3. externalDB.secretName - name of the secret with PostgreSQL credentials for Waldur user; should include username and password keys
  4. externalDB.serviceName - name of the service linked to PostgreSQL master

Zalando-managed PostgreSQL cluster example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: waldur-postgresql-<UNIQUE_SUFFIX_EG_CURRENT_DATE>
spec:
  teamId: "waldur"
  volume:
    size: 20Gi
  numberOfInstances: 2
  users:
    waldur:
    - superuser
    - createdb
  databases:
    waldur: waldur
  postgresql:
    version: "14"
  resources:
    requests:
      cpu: '500m'
      memory: 500Mi
    limits:
      cpu: '1'
      memory: 2Gi

Backup setup

Enable backups for a cluster with the following addition to a manifest file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: waldur-postgresql-<UNIQUE_SUFFIX_EG_CURRENT_DATE>
spec:
  # ...
  env:
    - name: AWS_ENDPOINT # S3-like storage endpoint
      valueFrom:
        secretKeyRef:
          key: URL
          name: postgres-cluster-backups-minio
    - name: AWS_ACCESS_KEY_ID # Username for S3-like storage
      valueFrom:
        secretKeyRef:
          key: username
          name: postgres-cluster-backups-minio
    - name: AWS_SECRET_ACCESS_KEY # Password for the storage
      valueFrom:
        secretKeyRef:
          key: password
          name: postgres-cluster-backups-minio
    - name: WAL_S3_BUCKET # Bucket name for the storage
      valueFrom:
        secretKeyRef:
          key: bucket
          name: postgres-cluster-backups-minio
    - name: USE_WALG_BACKUP # Enable backups to the storage
      value: 'true'
    - name: USE_WALG_RESTORE # Enable restore for replicas using the storage
      value: 'true'
    - name: BACKUP_SCHEDULE # Base backups schedule
      value: "0 2 * * *"

You also need to create a secret file with the credentials for the storage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# puhuri-core-dev
apiVersion: v1
kind: Secret
metadata:
  name: postgres-cluster-backups-minio
type: Opaque
data:
  URL: "B64_ENCODED_ENDPOINT"
  username: "B64_ENCODED_USERNAME"
  password: "B64_ENCODED_PASSWORD"
  bucket: "B64_ENCODED_BUCKET"

Trigger a base backup manually

Connect to the leader PSQL pod and execute the following commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
su postgres
envdir "/run/etc/wal-e.d/env" /scripts/postgres_backup.sh "/home/postgres/pgdata/pgroot/data"
# Output:
# ...
# INFO: 2023/08/24 10:27:05.159175 Wrote backup with name base_00000009000000010000009C
envdir "/run/etc/wal-e.d/env" wal-g backup-list
# Output:
# name                          modified             wal_segment_backup_start
# ...
# base_00000009000000010000009C 2023-08-24T10:27:05Z 00000009000000010000009C

Restore DB from backup

The preferable option is creation a new instance of PostgreSQL cluster cloning data from the original one.

For this, create a manifest with the following content:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: waldur-postgresql-<UNIQUE_SUFFIX_EG_CURRENT_DATE>
spec:
  clone:
    cluster: "waldur-postgresql-<SUFFIX>" # Name of a reference cluster
    timestamp: "2023-08-24T14:23:00+03:00" # Desired db snapshot time
    s3_wal_path: "s3://puhuri-core-dev/spilo/puhuri-core-dev-waldur-postgresql/wal/" # Path to a directory with WALs in S3 bucket
    s3_force_path_style: true # Use the path above
    env:
    # ...
    - name: CLONE_METHOD # Enable clone
      value: "CLONE_WITH_WALE"
    - name: CLONE_AWS_ENDPOINT # S3-like storage endpoint
      valueFrom:
        secretKeyRef:
          key: URL
          name: postgres-cluster-backups-minio
    - name: CLONE_AWS_ACCESS_KEY_ID # Username for S3-like storage
      valueFrom:
        secretKeyRef:
          key: username
          name: postgres-cluster-backups-minio
    - name: CLONE_AWS_SECRET_ACCESS_KEY # Password for the storage
      valueFrom:
        secretKeyRef:
          key: password
          name: postgres-cluster-backups-minio

Then, apply the manifest to the cluster, change externalDB.{secretName, serviceName} after DB bootstrap and upgrade Waldur release.

Official documentation

Documentation of installation link: Helm

Installing Helm

  1. Download and install Helm
1
2
3
  curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
  chmod 700 get_helm.sh
  ./get_helm.sh
  1. Check the version
1
  helm version

Host aliasing

You can specify additional hosts for Waldur containers in the same manner as the /etc/hosts file using host aliasing. To create aliases, a user needs to modify the hostAliases variable in waldur/values.yaml file. Example:

1
2
3
4
hostAliases:
  - ip: "1.2.3.4"
    hostnames:
      - "my.host.example.com"

This will add a record for my.host.example.com to the /etc/hosts file of all the Waldur containers

HPA setup and configuration

It is possible to use cpu-utilization-based HPA for API server (aka waldur-mastermind-api) and Celery executor (aka waldur-mastermind-worker and waldur-mastermind-beat) pods.

Setup

If you use minikube, you need to enable metrics-server using next command: minikube addons enable metrics-server

Configuration

In values.yaml file you can configure HPA for:

  1. API server (hpa.api prefix):

    1.1 enabled - flag for enabling HPA. Possible values: true for enabling and false for disabling.

    1.2 resources - custom resources for server. requests.cpu param is mandatory for proper HPA work.

    1.3 cpuUtilizationBorder - border percentage of average CPU utilization per pod for deployment.

  2. Celery (hpa.celery prefix):

    2.1 enabled - flag for enabling HPA, the same possible values as for API server.

    2.2 workerResources - custom resources for celery worker. requests.cpu param is mandatory for proper HPA work.

    2.3 beatResources - custom resources for celery beat. requests.cpu param is mandatory for proper HPA work.

    2.4 cpuUtilizationBorder - border percentage of average CPU utilization per pod for deployment.

Limiting network access to Mastermind APIs

Waldur Helm allows limiting network access to Mastermind API endpoints - i.e. /api/, /api-auth/, /admin/ - based on whitelisting the subnets from where access is allowed. To define a list of allowed subnets in CIDR format for the all the API endpoint, please use ingress.whitelistSourceRange option in values.yaml. Example:

1
2
3
4
...
ingress:
  whitelistSourceRange: '192.168.22.0/24'
...

Given this value, only IPs from 192.168.22.0/24 subnet are able to access Waldur Mastermind APIs.

In case you want to limit access to /api/admin/ endpoint specifically, there is another option called ingress.whitelistSourceRangeAdmin:

1
2
3
4
...
ingress:
  whitelistSourceRangeAdmin: '192.168.22.1/32'
...

This will limit access to the admin endpoint only for 192.168.22.1 IP. Note: The whitelistSourceRangeAdmin option takes precedence over whitelistSourceRange.

In case of multiple subnets/IPs, comma separated list can be used as a value. E.g.: 192.168.22.1/32,192.168.21.0/24. This works for both options.

Official documentation

Documentation of installation link: doc

Installing kubectl

  1. Download and install latest kubectl
1
  curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
  1. Add executable mode for kubectl
1
  chmod +x ./kubectl
  1. Move kubectl binary into your PATH
1
  sudo mv ./kubectl /usr/local/bin/kubectl
  1. Check the version
1
  kubectl version --client
  1. Show running Pods in cluster
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
  kubectl get po -A # -->
  # NAMESPACE     NAME                             READY STATUS  RESTARTS AGE
  # kube-system   coredns-66bff467f8-dcfxn         1/1   Running 0        ??m
  # kube-system   coredns-66bff467f8-tdgpn         1/1   Running 0        ??m
  # kube-system   etcd-minikube                    1/1   Running 0        ??m
  # kube-system   kindnet-4j8t6                    1/1   Running 0        ??m
  # kube-system   kube-apiserver-minikube          1/1   Running 0        ??m
  # kube-system   kube-controller-manager-minikube 1/1   Running 0        ??m
  # kube-system   kube-proxy-ft67m                 1/1   Running 0        ??m
  # kube-system   kube-scheduler-minikube          1/1   Running 0        ??m
  # kube-system   storage-provisioner              1/1   Running 0        ??m

Locust cofiguration

This chart uses Locust tool for stress testing.

Installation

Locust runs as another standalone Helm release.

Install Locust:

1
  helm install locust stable/locust -f locust-values.yaml

After release installation, some instructions regarding access to WEB UI for Locust printed in stdout.See this section for more information about UI interaction.

Configuration

You can change locust config with the folloving variables in locust-values.yaml:

  1. image.repository - repository of locust image
  2. image.tag - tag of locust image
  3. master.config - key-value configuration records for locust master (used as container env vars)
  4. master.config.locust-host - URL of target mastermind service. See this doc for details
  5. master.config.target-host - same as master.config.locust-host
  6. master.config.locust-mode-master - master mode flag. Please, don't change it, because for new versions of locust this flag is mandatory for a master node.
  7. master.config.locust-locustfile - path to the injected locust file. Please, don't change file directory (/locust-tasks/), because it is fixed mountpoint for pods. The filename itself can have any value, but should be the same as key in the configmap (worker.config.configmapName).
  8. worker.config - key-value configuration records for locust worker (used as container env vars).
  9. worker.config.configmapName - name of configmap with locustfile
  10. worker.config.locust-mode-worker - worker mode flag. Please, don't change it, because for new versions of locust this flag is mandatory for a worker node.
  11. worker.config.locust-locustfile - path to the injected locust file. Same rules as for master.config.locust-locustfile.
  12. worker.config.locust-master-node-host - hostname of the locust master service, which is formatted as <locust_release_name>-master-svc
  13. worker.replicaCount - number of locust workers

You can find available variables for master and worker configuration from chart desription and official locust documentation (most of the flags and args can be injected through env vars).

NB: The original helm chart image (greenbirdit/locust:0.9.0) has outdated locust version and doesn't support most of the current env variables from the first link above. Thus master.config.target-host is used only for compatibility and must be equal to master.config.locust-host

In the values.yaml you need to setup the following vars (stressTesting prefix):

  1. enabled - enable/disable stress testing
  2. locustFilePath - path to the locust file (should be in the waldur/ directory)

Waldur Marketplace script plugin setup

Available options in values.yaml:

  • waldur.marketplace.script.enabled - enable/disable plugin
  • waldur.marketplace.script.dockerImages - key-value structure, where key is a programming language and value - a corresponding docker image tag
  • waldur.marketplace.script.k8sNamespace - Kubernetes namespace, where jobs will be executed
  • waldur.marketplace.script.kubeconfigPath - path to local file with kubeconfig content
  • waldur.marketplace.script.kubeconfig - kubeconfig file content takes precedence over .kubeconfigPath option
  • waldur.marketplace.script.jobTimeout - timeout for Kubernetes jobs

Mastermind templates configuration

If you want to configure custom mastermind templates, you should:

  1. Setup waldur.mastermindTemplating.mastermindTemplatesPath in values.yaml (by default, it is equal to mastermind_templates/mastermind-templates.yaml). Alternatively, you can use waldur.mastermindTemplating.mastermindTemplates containing .yaml file strings to get rid of file usage.

  2. Put all the custom templates into the file in a following way:

NB: The keys in the file should have <waldur_application_name>/<event_name>_<postfix>.<extension>, where <postfix> can be either message or subject, and <extension> - either txt or html

1
2
3
4
5
<file-name1>: |
    <Custom content1>
<file-name2>: |
    <Custom content2>
...

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
users/invitation_notification_message.txt: |
    Hi!
users/invitation_notification_message.html: |
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation has been created</title>
    </head>
    <body>
    <p>
        Hi!
    </p>
    </body>
    </html>
...

Migration from Postgresql HA

Plan:

  1. Scale api, beat, worker -> 0
  2. Backup — using backup job
  3. group_vars/puhuri_core_prd - helm_pg_ha_enabled: no ===> CANCEL THE UPDATING PIPELINE!
  4. Run dependency update ==> leads to a working single psql
  5. Restore DB — using recovery job
  6. Run a common update pipeline
  7. Validate that login works
  8. Drop old psql ha, drop pvc
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Backup
kubectl exec -it postgresql-ha-waldur-postgresql-0 -- env PGPASSWORD=waldur pg_dump -h 0.0.0.0 -U waldur waldur | gzip -9 > backup.sql.gz

# Backup restoration
# Locally
kubectl cp backup.sql.gz postgresql-waldur-0:/tmp/backup.sql.gz
kubectl exec -it postgresql-waldur-0 -- bash

# In pgpool pod
gzip -d /tmp/backup.sql.gz
export PGPASSWORD=waldur
psql -U waldur -h 0.0.0.0 -f /tmp/backup.sql

Official documentation

Documentation of installation link: doc

Installing minikub

  1. Download and install minikube

  2. For Debial/Ubuntu:

1
2
  curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube_1.9.1-0_amd64.deb
  sudo dpkg -i minikube_1.9.1-0_amd64.deb
  • For Fedora/Red Hat
1
2
  curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-1.9.1-0.x86_64.rpm
  sudo rpm -ivh minikube-1.9.1-0.x86_64.rpm
  • Others (direct installation)
1
2
  curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
  sudo install minikube-linux-amd64 /usr/local/bin/minikube
  1. Set docker as a default driver
1
2
3
  minikube config set driver docker
  minikube delete # delete previous profile
  minikube config get driver # --> docker
  1. Start local kubernetes cluster
1
2
3
4
5
6
7
  minikube start
  minikube status # -->
  # m01
  # host: Running
  # kubelet: Running
  # apiserver: Running
  # kubeconfig: Configured

Min.io configuration

Min.io storage is used as a database backup storage.

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install minio release:

1
  helm install minio bitnami/minio -f minio-values.yaml

You can change minio config with next vars (in minio.values file):

  1. accessKey.password - access key id for storage
  2. secretKey.password - secret key itself
  3. serviceAccount.name - name of the service account for MinIO
  4. persistence.enabled - persistence enabling flag
  5. persistence.size - size of storage per each pod
  6. ingress - ingress settings
  7. defaultBuckets - default buckets created after release installation (comma-separated list of strings)

For more configuration values follow this link.

In Waldur Helm values.yaml you need to setup:

  1. minio.accessKey - should be same as accessKey in minio.values.yaml
  2. minio.secretKey - should be same as secretKey in minio.values.yaml
  3. minio.bucketName - should be same as a value from defaultBuckets list in minio-values.yaml
  4. minio.endpoint - access URL to minio storage (minio service host and port). See this doc for details.

PostgreSQL backup configuration

There are the following jobs for backups management:

  • CronJob for backups creation (running by a schedule postgresBackup.schedule)

  • CronJob for backups rotation (running by a schedule postgresBackup.rotationSchedule)

Backup configuration values (postgresBackup prefix):

  • enabled - boolean flag for enabling/disabling backups

  • schedule - cron-like schedule for backups

  • rotationSchedule - cron-like schedule for backups rotation

  • maxNumber - maximum number of backups to store

  • image - Docker image containing potgres and minio (client) binaries (opennode/postgres-minio by default)

Backups restoration

To restore backups you need to connect to the restoration pod. The major prerequisite for this is stopping the Waldur backend pods to avoid errors. NB: During restoration process, the site will be unavailable. For this, please execute the following lines in the Kubernetes node:

1
2
3
4
5
6
# Stop all the API pods
kubectl scale --replicas=0 deployment/waldur-mastermind-api
# Stop all the Celery worker pods
kubectl scale --replicas=0 deployment/waldur-mastermind-worker
# Connect to the restoration pod
kubectl exec -it deployment/waldur-db-restore -- bash

This will give you access to a terminal of a restoration pod. In this shell, please, execute the command:

1
db-backup-minio-auth

This will print the recent 5 backups available for restoration. Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
root@waldur-db-restore-ff7f586bb-nb8jt:/# db-backup-minio-auth
[+] LOCAL_PG_BACKUPS_DIR :
[+] MINIO_PG_BACKUPS_DIR : pg/data/backups/postgres
[+] Setting up the postgres alias for minio server (http://minio.default.svc.cluster.local:9000)
[+] Last 5 backups
[2022-12-01 05:00:02 UTC]  91KiB backup-2022-12-01-05-00.sql.gz
[2022-11-30 05:00:02 UTC]  91KiB backup-2022-11-30-05-00.sql.gz
[2022-11-29 05:00:02 UTC]  91KiB backup-2022-11-29-05-00.sql.gz
[2022-11-28 16:30:37 UTC]  91KiB backup-2022-11-28-16-30.sql.gz
[2022-11-28 16:28:27 UTC]  91KiB backup-2022-11-28-16-28.sql.gz
[+] Finished

As you can see, the backup name contains the date and time when it was created in YYYY-mm-dd-HH-MM format. You can freely choose the one you need.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
  db-backup-minio-auth
  export BACKUP_FILENAME=<SELECTED_BACKUP>
  mc cp pg/$MINIO_BUCKET/backups/postgres/$BACKUP_FILENAME backup.sql.gz
  gzip -d backup.sql.gz
  # Be careful: the next lines have potentially danger operations
  psql -d postgres -c "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = 'waldur' AND pid <> pg_backend_pid();"
  psql -d postgres -c 'DROP DATABASE waldur;'
  createdb waldur
  psql -f backup.sql
  rm backup.sql

Restoration from external backup

If you want to use a pre-created backup from an external system, copy the backup file:

  1. Copy the backup file to your local machine

  2. Copy the file to pod

    1
2
    export RESTORATION_POD_NAME=$(kubectl get pods --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep restore)
kubectl cp <BACKUP_FILE> $RESTORATION_POD_NAME:/tmp/backup.sql.gz

  3. Connect to pod's terminal

    1
    kubectl exec -it $RESTORATION_POD_NAME -- bash

  4. Apply the backup

    1
2
3
4
5
6
7
    gzip -d /tmp/backup.sql.gz
# Be careful: the next lines have potentially danger operations
psql -d postgres -c "SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = 'waldur' AND pid <> pg_backend_pid();"
psql -d postgres -c 'DROP DATABASE waldur;'
createdb waldur
psql -f /tmp/backup.sql
rm /tmp/backup.sql

PostgreSQL HA chart configuration

bitnami/postgresql-ha is used as a highly available database for Waldur.

Standalone installation

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install postgresql-ha release:

1
2
  helm install postgresql-ha bitnami/postgresql-ha \
    -f postgresql-ha-values.yaml --version 14.2.34

NB: the value postgresqlha.enabled for waldur release must be true.

Chart configuration

You can change default PostgreSQL config with the following variables in values.yaml (postgresql-ha-values.yaml file):

  1. postgresql.database - name of a database. NB: must match postgresqlha.postgresql.database value in waldur/values.yaml
  2. postgresql.username - name of a database user. NB: must match postgresqlha.postgresql.username value in waldur/values.yaml
  3. postgresql.password - password of a database user
  4. postgresql.replicaCount - number of db replicas
  5. postgresql.repmgrPassword - password of repmgr user
  6. persistence.size - size of a database (for each replica)
  7. pgpool.image.tag - tag of Pgpool image. Possible tags for default image can be found here
  8. postgresql.image.tag - tag of PostgreSQL image. Possible tags for default image can be found here

More information related to possible values here.

Dependency installation

Waldur Helm chart supports PostgreSQL HA installation as a dependency. For this, set postgresqlha.enabled to true and update related settings in postgresqlha section in waldur/values.yaml

NB: the value postgresql.enabled and externalDB.enabled must be false.

Prior Waldur installation, update chart dependencies:

1
helm dependency update

PostgreSQL chart configuration (without HA support)

bitnami/postgresql chart is used as a database for Waldur.

Standalone installation

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install postgresql release:

1
  helm install postgresql bitnami/postgresql --version 16.0.1 -f postgresql-values.yaml

NB: the values postgresql.enabled and postgresqlha.enabled must be false.

Chart configuration

You can change default PostgreSQL config with the following variables in postgresql-values.yaml:

  1. auth.database - name of a database. NB: must match postgresql.database value in waldur/values.yaml
  2. auth.username - name of a database user. NB: must match postgresql.username value in waldur/values.yaml
  3. auth.password - password of a database user
  4. primary.persistence.size - size of a database
  5. image.tag - tag of PostgreSQL image. Possible tags for default image can be found here
  6. image.registry - registry of PostgreSQL image.

More information related to possible values here.

Dependency installation

Waldur Helm chart supports PostgreSQL installation as a dependency. For this, set postgresql.enabled to true and update related settings in postgresql section in waldur/values.yaml

NB: the value postgresqlha.enabled and externalDB.enabled must be false.

Prior Waldur installation, update chart dependencies:

1
helm dependency update

Readonly user configuration

In order to enable /api/query/ endpoint please make sure that read-only user is configured.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
-- Create a read-only user
CREATE USER readonly WITH PASSWORD '{readonly_password}'

-- Grant read-only access to the database
GRANT CONNECT ON DATABASE '{database_name}' TO '{readonly_username}'

-- Grant read-only access to the schema
GRANT USAGE ON SCHEMA public TO '{readonly_username}'

-- Grant read-only access to existing tables
GRANT SELECT ON ALL TABLES IN SCHEMA public TO '{readonly_username}'

-- Grant read-only access to future tables
ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO '{readonly_username}'

-- Revoke access to authtoken_token table
REVOKE SELECT ON authtoken_token FROM '{readonly_username}'

Proxy setup for Waldur components

You can setup the proxy environment variables https_proxy, http_proxy and no_proxy for Waldur component containers. For this, please set values for the proxy.httpsProxy, proxy.httpProxy and proxy.noProxy variables in waldur/values.yaml file.

Example:

1
2
3
4
proxy:
  httpsProxy: "https://proxy.example.com/"
  httpProxy: "http://proxy.example.com/"
  noProxy: ".test"

Note: you can set variables separately, i.e. leave some of them blank:

1
2
3
4
proxy:
  httpsProxy: ""
  httpProxy: "http://proxy.example.com/"
  noProxy: ".test"

In the previous example, the https_proxy env variable won't be present in the containers.

RabbitMQ configuration

For rabbitmq installation, bitnami/rabbitmq is used.

Installation

Add bitnami repo to helm:

1
  helm repo add bitnami https://charts.bitnami.com/bitnami

Install rabbitmq-ha release:

1
  helm install rmq bitnami/rabbitmq --version 15.0.2 -f rmq-values.yaml

Configuration

You can change rabbitmq config with the following variables in rmq-values.yaml:

  1. replicaCount - number RMQ instances
  2. persistence.enabled - enable/disable persistence
  3. persistence.size - size for singe PV
  4. persistence.storageClass - storage class for PV
  5. auth.username - username for RMQ user
  6. auth.password - password for RMQ user

For more config values, see this section

In values.yaml file, you need to setup the following vars (rabbitmq prefix):

  1. auth.username - should be same as auth.username in the rmq-values.yaml file
  2. auth.password - should be same as auth.password in the rmq-values.yaml file
  3. host - rabbitmq service hostname (See this doc for details)
  4. customManagementPort - custom port for rabbitmq management interface
  5. customAMQPPort - custom port for AMQP access

Additional Protocol Support

The chart supports additional messaging protocols beyond AMQP:

  • MQTT (port 1883) - for IoT device communication
  • STOMP (port 61613) - for simple text-based messaging
  • WebSocket variants (ports 15674, 15675) - for browser-based connections

These protocols are enabled through the extraPlugins configuration:

1
extraPlugins: "rabbitmq_auth_backend_ldap rabbitmq_mqtt rabbitmq_web_mqtt rabbitmq_management rabbitmq_web_stomp rabbitmq_stomp"

Additional container and service ports are automatically configured for these protocols.

SAML2 configuration

To configure SAML2 for Waldur:

  1. Enable SAML2 support in values.yaml: add SAML2 string into waldur.authMethods list
  2. Set source directory in waldur.saml2.dir
  3. Place necessary files in the directory with the following manner (. is the source directory root):
    • sp.crt -> ./
    • sp.pem -> ./
    • saml2.conf.py -> ./

Service endpoints

For communication inside a cluster, pods use services. Usually, that needs to define internal endpoints with service URL format.

NB: It is important to set up namespace part correctly. If not, requests can come to unexpected service, which will cause errors.

Endpoint format

Fully qualified endpoint format is:

1
http://<service-name>.<namespace>.svc.<cluster>:<service-port>

Where

  • <service-name>.<namespace>.svc.<cluster> - hostname of service
  • <service-port> - port of service

For example:

  • hostname is elasticsearch-master.elastic.svc.cluster.local
  • service port is 9200
  • final URL is http://elasticsearch-master.elastic.svc.cluster.local:9200

If pods run in the same namespace and cluster, it can be simplified to:

1
http://<service-name>:<service-port>

For example: http://elasticsearch-master:9200

TLS configuration instructions

To enable tls globally please set ingress.tls.enabled=true in values.yaml

Let’s Encrypt setup

If you want to configure letsencrypt certification, you need to:

  1. Set ingress.tls.source="letsEncrypt" in values.yaml
  2. Create namespace for cert-manager
1
kubectl create namespace cert-manager
  1. Add repository and update repos list
1
2
  helm repo add jetstack https://charts.jetstack.io
  helm repo update
  1. Install cert-manager release
1
2
3
4
5
  helm install \
    cert-manager jetstack/cert-manager \
    --namespace cert-manager \
    --version v1.15.3 \
    --set crds.enabled=true
  1. After that, waldur release is ready for installation.

Your own certificate

In case, when you want to use own certificate, you need to:

  1. Set ingress.tls.source="secret" in values.yaml
  2. Set ingress.tls.secretsDir variable to directory with your tls.crt and tls.key files. By default it is set to tls
  3. After that, waldur release is ready for installation

White-labeling instructions

To setup white-labeling, you can define next variables in waldur/values.yaml file:

  • shortPageTitle - custom prefix for page title
  • modePageTitle - custom page title
  • loginLogoPath - path to custom .png image file for login page (should be in waldur/ chart directory)
  • sidebarLogoPath - path to custom .png image file for sidebar header (should be in waldur/ chart directory)
  • sidebarLogoDarkPath - path to custom .png image file for sidebar header in dark mode (should be in waldur/ chart directory)
  • poweredByLogoPath - path to custom .png image file for "powered by" part of login page (should be in waldur/ chart directory)
  • faviconPath - path to custom favicon .png image file
  • tosHtmlPath - path to custom terms of service file (tos.html)
  • privacyHtmlPath - path to custom privacy statement file (privacy.html)
  • brandColor - Hex color definition is used in HomePort landing page for login button.
  • heroImagePath - Relative path to image rendered at hero section of HomePort landing page.
  • heroLinkLabel - Label for link in hero section of HomePort landing page. It can be lead to support site or blog post.
  • heroLinkUrl - Link URL in hero section of HomePort landing page.
  • siteDescription - text at hero section of HomePort landing page.

NB:

  • the *Path values take place only if respectful *Url values are not specified. If both types are defined, the precedence is taken by URL(*Url) for all cases.
  • all of imported files must be within chart root directory

Alternatively, TOS and PP files content can be provided as multiline values in tosHtml and privacyHtml options respectfully. If defined, they take precedence over the aforementioned ones.

Ended: Docs

Ended: Helm

Ended: Deployment

LDAP

Waldur allows you to authenticate using identities from a LDAP server.

Prerequisites

  • Below it is assumed that LDAP server is provided by FreeIPA. Although LDAP authentication would work with any other LDAP server as well, you may need to customize configuration for Waldur MasterMind.
  • Please ensure that Waldur Mastermind API server has access to the LDAP server. By default LDAP server listens on TCP and UDP port 389, or on port 636 for LDAPS (LDAP over SSL). If this port is filtered out by firewall, you wouldn't be able to authenticate via LDAP.
  • You should know LDAP server URI, for example, FreeIPA demo server has ldap://ipa.demo1.freeipa.org.
  • You should know username and password of LDAP admin user. For example, FreeIPA demo server uses username=admin and password=Secret123.

Add LDAP configuration to Waldur Mastermind configuration

Example configuration is below, please adjust to your specific deployment.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import ldap
from django_auth_ldap.config import LDAPSearch, GroupOfNamesType

# LDAP authentication.
# See also: https://django-auth-ldap.readthedocs.io/en/latest/authentication.html
AUTHENTICATION_BACKENDS += (
    'django_auth_ldap.backend.LDAPBackend',
)

AUTH_LDAP_SERVER_URI = 'ldap://ipa.demo1.freeipa.org'

# Following variables are not used by django-auth-ldap,
# they are used as templates for other variables
AUTH_LDAP_BASE = 'cn=accounts,dc=demo1,dc=freeipa,dc=org'
AUTH_LDAP_USER_BASE = 'cn=users,' + AUTH_LDAP_BASE

# Format authenticating user's distinguished name using template
AUTH_LDAP_USER_DN_TEMPLATE = 'uid=%(user)s,' + AUTH_LDAP_USER_BASE

# Credentials for admin user
AUTH_LDAP_BIND_DN = 'uid=admin,' + AUTH_LDAP_USER_BASE
AUTH_LDAP_BIND_PASSWORD = 'Secret123'

# Populate the Django user from the LDAP directory.
AUTH_LDAP_USER_ATTR_MAP = {
    'full_name': 'displayName',
    'email': 'mail'
}

# Set up the basic group parameters.
AUTH_LDAP_GROUP_BASE = "cn=groups," + AUTH_LDAP_BASE
AUTH_LDAP_GROUP_FILTER = "(objectClass=groupOfNames)"
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_BASE,
    ldap.SCOPE_SUBTREE, AUTH_LDAP_GROUP_FILTER)
AUTH_LDAP_GROUP_TYPE = GroupOfNamesType(name_attr="cn")

AUTH_LDAP_USER_FLAGS_BY_GROUP = {
    'is_staff': 'cn=admins,' + AUTH_LDAP_GROUP_BASE,
    'is_support': 'cn=support,' + AUTH_LDAP_GROUP_BASE,
}

Configuration above is based on LDAP server exposed by FreeIPA. To make it work, there are some things that need to be verified in FreeIPA:

  1. Ensure that admins and support groups exist in LDAP server. You may do it using FreeIPA admin UI. FreeIPA groups
  2. If user is assigned to admins group in LDAP, he becomes staff in Waldur. If user is assigned to support group in LDAP, he becomes support user in Waldur. For example, consider the manager user which belong to both groups:

Manager user

Field mapping

displayName attribute in LDAP is mapped to full_name attribute in Waldur. mail field in LDAP is mapped to email attribute in Waldur.

Consider for example, the following user attributes in LDAP:

LDAP explorer

Here's how it is mapped in Waldur:

Waldur admin

And here's how it is displayed when user initially logs into Waldur via HomePort:

Homeport login

MyAccessID

Waldur supports integration with MyAccessID identity service.

The MyAccessID Identity and Access Management Service is provided by GEANT with the purpose of offering a common Identity Layer for Infrastructure Service Domains (ISDs).

The AAI proxy of MyAccessID connects Identity Providers from eduGAIN, specific IdPs which are delivered in context of ISDs such as HPC IdPs, eIDAS eIDs and potentially other IdPs as requested by ISDs.

MyAccessID delivers the Discovery Service used during the user authentication process for users to choose their IdP. It enables the user to register an account in the Account Registry, to link different identities and it guarantees the uniqueness and persistence of the user identifier towards connected ISDs.

To enable MyAccessID, please register a new client for Waldur deployment and set configuration settings for MyAccessID. Check configuration guide for available settings.

Fetch user data using CUID of a user

You can use CUID of user in order to fetch user permissions from MyAccessID registry. This document describes how to perform it via Waldur shell.

TARA

Waldur supports integration with TARA authentication service.

To enable it, please register a new client for Waldur deployment and set configuration settings for TARA. Check configuration guide for available settings.

eduGAIN

Overview

eduGAIN is a global federation of identity and service providers, based technically on SAML2.

In order to allow eduGAIN users to access Waldur, there are two steps:

  • Waldur deployment must be registered as a service provider in eduGAIN federation.
  • Waldur must get a list of identities that are trusted for authentication.

Tip

SAML is a complicated and fragile technology. GEANT provides an alternative to direct integration of SAML - eduTEAMS, which exposes an OpenID Connect protocol for service providers.

Waldur relies on djangosaml2 for the heavylifting of SAML processing, so for fine tuning configuration, contact corresponding project documentation.

Registering Waldur as Service Provider

Add SAML configuration to Waldur Mastermind configuration

Example configuration is below, please adjust to your specific deployment. Once applied, service metadata will be visible at Waldur deployment URL: https://waldur.example.com/api-auth/saml2/metadata/. That data needs to be propagated to the federation operator for inclusion into the federation.

Tip

Managed ansible simplifies configuration of the eduGAIN integration and should be a preferred method for all supported deployments.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
import datetime

import saml2
from saml2.entity_category.edugain import COC


WALDUR_AUTH_SAML2 = {
    # used for assigning the registration method to the user
    'name': 'saml2',
    # full path to the xmlsec1 binary program
    'xmlsec_binary': '/usr/bin/xmlsec1',
    # required for assertion consumer, single logout services and entity ID
    'base_url': '',
    # directory with attribute mapping
    'attribute_map_dir': '',
    # set to True to output debugging information
    'debug': False,
    # IdPs metadata XML files stored locally
    'idp_metadata_local': [],
    # IdPs metadata XML files stored remotely
    'idp_metadata_remote': [],
    # logging
    # empty to disable logging SAML2-related stuff to file
    'log_file': '',
    'log_level': 'INFO',
    # Indicates if the entity will sign the logout requests
    'logout_requests_signed': 'true',
    # Indicates if the authentication requests sent should be signed by default
    'authn_requests_signed': 'true',
    # Identifies the Signature algorithm URL according to the XML Signature specification
    # SHA1 is used by default
    'signature_algorithm': None,
    # Identifies the Message Digest algorithm URL according to the XML Signature specification
    # SHA1 is used by default
    'digest_algorithm': None,
    # Identified NameID format to use. None means default, empty string ("") disables addition of entity
    'nameid_format': None,
    # PEM formatted certificate chain file
    'cert_file': '',
    # PEM formatted certificate key file
    'key_file': '',
    # SAML attributes that are required to identify a user
    'required_attributes': [],
    # SAML attributes that may be useful to have but not required
    'optional_attributes': [],
    # mapping between SAML attributes and User fields
    'saml_attribute_mapping': {},
    # organization responsible for the service
    # you can set multilanguage information here
    'organization': {},
    # links to the entity categories
    'categories': [COC],
    # attributes required by CoC
    # https://wiki.refeds.org/display/CODE/SAML+2+Profile+for+the+Data+Protection+Code+of+Conduct
    'privacy_statement_url': 'http://example.com/privacy-policy/',
    'display_name': 'Service provider display name',
    'description': 'Service provider description',
    # mdpi attributes
    'registration_policy': 'http://example.com/registration-policy/',
    'registration_authority': 'http://example.com/registration-authority/',
    'registration_instant': datetime.datetime(2017, 1, 1).isoformat(),
    'ENABLE_SINGLE_LOGOUT': False,
    'ALLOW_TO_SELECT_IDENTITY_PROVIDER': True,
    'IDENTITY_PROVIDER_URL': None,
    'IDENTITY_PROVIDER_LABEL': None,
    'DEFAULT_BINDING': saml2.BINDING_HTTP_POST,
    'DISCOVERY_SERVICE_URL': None,
    'DISCOVERY_SERVICE_LABEL': None,
}

Example of generated metadata

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<?xml version="1.0" encoding="UTF-8"?>
<ns0:EntityDescriptor xmlns:ns0="urn:oasis:names:tc:SAML:2.0:metadata" xmlns:ns1="urn:oasis:names:tc:SAML:metadata:attribute" xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns4="urn:oasis:names:tc:SAML:metadata:algsupport" xmlns:ns5="urn:oasis:names:tc:SAML:metadata:rpi" xmlns:ns6="urn:oasis:names:tc:SAML:metadata:ui" xmlns:ns7="http://www.w3.org/2000/09/xmldsig#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" entityID="https://api.etais.ee/api-auth/saml2/metadata/">
   <ns0:Extensions>
      <ns1:EntityAttributes>
         <ns2:Attribute Name="http://macedir.org/entity-category" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
            <ns2:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">http://www.geant.net/uri/dataprotection-code-of-conduct/v1</ns2:AttributeValue>
         </ns2:Attribute>
      </ns1:EntityAttributes>
      <ns4:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#sha224" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#sha384" />
      <ns4:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha512" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2000/09/xmldsig#dsa-sha1" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2009/xmldsig11#dsa-sha256" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha224" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha224" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha384" />
      <ns4:SigningMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha512" />
      <ns5:RegistrationInfo registrationAuthority="http://taat.edu.ee" registrationInstant="2017-01-01T00:00:00">
         <ns5:RegistrationPolicy xml:lang="en">http://taat.edu.ee/main/wp-content/uploads/Federation_Policy_1.3.pdf</ns5:RegistrationPolicy>
      </ns5:RegistrationInfo>
   </ns0:Extensions>
   <ns0:SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" AuthnRequestsSigned="true" WantAssertionsSigned="true">
      <ns0:Extensions>
         <ns6:UIInfo>
            <ns6:DisplayName xml:lang="en">ETAIS Self-Service</ns6:DisplayName>
            <ns6:Description xml:lang="en">Self-service for users of Estonian Scientific Computing Infrastructure (ETAIS)</ns6:Description>
            <ns6:Logo>https://minu.etais.ee/login-logo.png</ns6:Logo>
            <ns6:PrivacyStatementURL xml:lang="en">https://minu.etais.ee/views/policy/privacy-full.html</ns6:PrivacyStatementURL>
         </ns6:UIInfo>
      </ns0:Extensions>
      <ns0:KeyDescriptor use="signing">
         <ns7:KeyInfo>
            <ns7:X509Data>
               <ns7:X509Certificate>MIIDVzCCAj+gAwIBAgIJAN80zoFR2/UbMA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMTcwNDIxMDczMzA1WhcNMjcwNDIxMDczMzA1WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA o87tb/hEU/igqFPtCFKMvC6LozTbH9y3I4lUVH38FDavDzrHAg1sVr5FEqguApeT xr/cmzsFMIB+XkAf9oI8xi2lUdorgeZFPFnUH0um4yXIJwBjrmgofUcybt84ee44 tM7AZKCAhinFDQUbjYV1LQP44QvFdGiklHGoo2NaVEqJwH6ce/8ioG5aFf2ISS6p fh3qOGVuQgansHFn+v+CvX+JU6FHB7mP+h3Xv+AoVjPz7b7E58rxn9qspy/N4LbB iDk7iBidsXEWYwYsSVP2cTrgKFktn5tB4YYZe0pSZNoCeVq05RK7kBy8yYCWTVZN Emkz5avL9Z2SDaGLY/9CTwIDAQABo1AwTjAdBgNVHQ4EFgQUrdY8o4OeseOy7ReD ZEZCKUZTk2gwHwYDVR0jBBgwFoAUrdY8o4OeseOy7ReDZEZCKUZTk2gwDAYDVR0T BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAoaygm+5U4j3/djWGQulXS2gdrPJV AS8zBuzQPVkhH76WcD8wxzuoceM80jPWLcP6Eq5Tma7rrqOE+QHrY8bm7LIYUEn2 fK/whozFyZ+TswEaDRjN6wL/FDuhu472Lnsg3rvE6s0eW1nlOHuqmqBQPb/kIMOj B3KOI6pqEfb+FqiZ2J/u/4KiOWaA8X9JQUo+HzWNEAPnNUoTl/yGr0Ad6z9YFbsu VnvJVTtGcu8pB5cjm7UtfN73ywEm/a/QXplus0U/Kv5XsSqaGa/Gw6pyX8LOc2yq I0XyOzj7DUcvMVZr5Vf/FVO2Od0Pb03+Wv4JRB5vXM1MsU+xAVgCm0pfew==</ns7:X509Certificate>
            </ns7:X509Data>
         </ns7:KeyInfo>
      </ns0:KeyDescriptor>
      <ns0:KeyDescriptor use="encryption">
         <ns7:KeyInfo>
            <ns7:X509Data>
               <ns7:X509Certificate>MIIDVzCCAj+gAwIBAgIJAN80zoFR2/UbMA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMTcwNDIxMDczMzA1WhcNMjcwNDIxMDczMzA1WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA o87tb/hEU/igqFPtCFKMvC6LozTbH9y3I4lUVH38FDavDzrHAg1sVr5FEqguApeT xr/cmzsFMIB+XkAf9oI8xi2lUdorgeZFPFnUH0um4yXIJwBjrmgofUcybt84ee44 tM7AZKCAhinFDQUbjYV1LQP44QvFdGiklHGoo2NaVEqJwH6ce/8ioG5aFf2ISS6p fh3qOGVuQgansHFn+v+CvX+JU6FHB7mP+h3Xv+AoVjPz7b7E58rxn9qspy/N4LbB iDk7iBidsXEWYwYsSVP2cTrgKFktn5tB4YYZe0pSZNoCeVq05RK7kBy8yYCWTVZN Emkz5avL9Z2SDaGLY/9CTwIDAQABo1AwTjAdBgNVHQ4EFgQUrdY8o4OeseOy7ReD ZEZCKUZTk2gwHwYDVR0jBBgwFoAUrdY8o4OeseOy7ReDZEZCKUZTk2gwDAYDVR0T BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAoaygm+5U4j3/djWGQulXS2gdrPJV AS8zBuzQPVkhH76WcD8wxzuoceM80jPWLcP6Eq5Tma7rrqOE+QHrY8bm7LIYUEn2 fK/whozFyZ+TswEaDRjN6wL/FDuhu472Lnsg3rvE6s0eW1nlOHuqmqBQPb/kIMOj B3KOI6pqEfb+FqiZ2J/u/4KiOWaA8X9JQUo+HzWNEAPnNUoTl/yGr0Ad6z9YFbsu VnvJVTtGcu8pB5cjm7UtfN73ywEm/a/QXplus0U/Kv5XsSqaGa/Gw6pyX8LOc2yq I0XyOzj7DUcvMVZr5Vf/FVO2Od0Pb03+Wv4JRB5vXM1MsU+xAVgCm0pfew==</ns7:X509Certificate>
            </ns7:X509Data>
         </ns7:KeyInfo>
      </ns0:KeyDescriptor>
      <ns0:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://api.etais.ee/api-auth/saml2/logout/complete/" />
      <ns0:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.etais.ee/api-auth/saml2/logout/complete/" />
      <ns0:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.etais.ee/api-auth/saml2/login/complete/" index="1" />
      <ns0:AttributeConsumingService index="1">
         <ns0:ServiceName xml:lang="en">ETAIS Self-Service</ns0:ServiceName>
         <ns0:RequestedAttribute Name="urn:mace:dir:attribute-def:cn" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="cn" isRequired="true" />
         <ns0:RequestedAttribute Name="urn:oid:0.9.2342.19200300.100.1.3" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="mail" isRequired="true" />
         <ns0:RequestedAttribute Name="schacPersonalUniqueID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" isRequired="true" />
         <ns0:RequestedAttribute Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.6" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="eduPersonPrincipalName" isRequired="true" />
         <ns0:RequestedAttribute Name="schacHomeOrganization" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" isRequired="false" />
         <ns0:RequestedAttribute Name="urn:oid:2.16.840.1.113730.3.1.39" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="preferredLanguage" isRequired="false" />
         <ns0:RequestedAttribute Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.9" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri" FriendlyName="eduPersonScopedAffiliation" isRequired="false" />
      </ns0:AttributeConsumingService>
   </ns0:SPSSODescriptor>
   <ns0:Organization>
      <ns0:OrganizationName xml:lang="et">ETAIS</ns0:OrganizationName>
      <ns0:OrganizationName xml:lang="en">ETAIS</ns0:OrganizationName>
      <ns0:OrganizationDisplayName xml:lang="et">ETAIS</ns0:OrganizationDisplayName>
      <ns0:OrganizationDisplayName xml:lang="en">ETAIS</ns0:OrganizationDisplayName>
      <ns0:OrganizationURL xml:lang="et">http://etais.ee/</ns0:OrganizationURL>
      <ns0:OrganizationURL xml:lang="en">http://etais.ee/</ns0:OrganizationURL>
   </ns0:Organization>
   <ns0:ContactPerson contactType="technical">
      <ns0:GivenName>Administrator</ns0:GivenName>
      <ns0:EmailAddress>etais@etais.ee</ns0:EmailAddress>
   </ns0:ContactPerson>
</ns0:EntityDescriptor>

Adding trusted identity providers

In order to configure Waldur to use SAML2 authentication you should specify identity provider metadata.

  • If metadata XML is stored locally, it is cached in the local SQL database. Usually metadata XML file is big, so it is necessary to use local cache in this case. But you should ensure that metadata XML file is refreshed via cron on a regular basis. A management command waldur sync_saml2_providers performs refreshing of the data.
  • If metadata XML is accessed remotely, it is not cached in SQL database. Therefore you should ensure that metadata XML is small enough. In this case you should download metadata signing certificate locally and specify its path in Waldur configuration. The certificate is used to retrieve the metadata securely. Please note that security certificates are updated regularly, therefore you should update configuration whenever certificate is updated. By convention, both metadata signing certificate and metadata itself are downloaded to /etc/waldur/saml2 in Waldur Mastermind instances.

References

TAAT configuration

TaaT certificates can be downloaded from: http://taat.edu.ee/main/dokumendid/sertifikaadid/.

Metadata URL for test hub is https://reos.taat.edu.ee/saml2/idp/metadata.php and for production hub is https://sarvik.taat.edu.ee/saml2/idp/metadata.php. Note, the certificate must correspond to the hub you want connect to.

Using Janus

Janus is a self-service for managing Service Provider records.

  • Create a new connection:

Janus

New connection ID must be equal to the base_url in saml.conf.py + /apu-auth/saml2/metadata/

  • Choose SAML 2.0 SP for connection type.
  • Click Create button
  • In connection tab select or create ARP. Fields that ARP include must be in the saml_attribute_mapping.
  • Navigate to the Import metadata tab and paste same URL as in the first step. Click on the Get metadata.
  • Navigate to the Validate tab and check whether all the tests pass. You can fix metadata in Metadata tab.

HAKA configuration

Production hub metadata is described at https://wiki.eduuni.fi/display/CSCHAKA/Haka+metadata.

Test hub metadata is described at https://wiki.eduuni.fi/display/CSCHAKA/Verifying+Haka+compatibility.

FEDI configuration

Production hub metadata is described at https://fedi.litnet.lt/en/metadata.

Discovery is supported: https://discovery.litnet.lt/simplesaml/module.php/discopower/disco.php.

eduTEAMS

Waldur supports integration with eduTEAMS identity service.

To enable it, please register a new client for Waldur deployment and set configuration settings for eduTEAMS. Check configuration guide for available settings.

Fetch user data using CUID of a user

You can use CUID of user in order to fetch user permissions. This file describes how to perform it, you only need to provide CUID as a username.

FreeIPA

Tip

For integrating FreeIPA as source of identities, please see LDAP. This module is about synchronising users from Waldur to FreeIPA

For situations when you would like to provide access to services based on the Linux usernames, e.g. for SLURM deployments, you might want to map users from Waldur (e.g. created through eduGAIN) to an external FreeIPA service.

To do that, you need to enable module and define settings for accessing FreeIPA REST APIs. See Waldur configuration guide for the list of supported FreeIPA settings.

At the moment at most one deployment of FreeIPA per Waldur is supported.

Keycloak

Waldur supports integration with Keycloak identity manager.

Below is a guide to configure Keycloak OpenID Connect client and Waldur intergration.

Configuring Keycloak

Instructions below are aimed to provide a basic configuration of Keycloak, please refer to Keycloak documentation for full details.

  1. Login to admin interface of Keycloak.
  2. Create a new realm (or use existing) New realm
  3. Open a menu with a list of clients. List clients
  4. Add a new client for Waldur by clicking on Create client button. Add client
  5. Make sure that Client authentication is enabled. Set access type
  6. Change client's Valid redirect URIs to "*". Valid redirect URIs
  7. Copy secret code from Credentials tab. Secret code
  8. You can find the settings required for configuration of Waldur under the following path on your Keycloak deployment (change test-waldur to the realm that you are using): /realms/test-waldur/.well-known/openid-configuration

Configuring Waldur

  1. Make sure SOCIAL_SIGNUP is added to the list of available authentication methods:

    1
    WALDUR_CORE['AUTHENTICATION_METHODS'] = ["LOCAL_SIGNIN", "SOCIAL_SIGNUP"]

Identity providers 3. Open Keycloak identity provider details by clicking on Edit menu of Keycloak dropdown menu HomePort provider details 4. Copy Client ID, Client secret and Discovery URL. For extra security, enable SSL, PKCE and post-logout redirect.

Summary

Name Protocol Description
eduGAIN SAML Federation of research and educational providers supported by Geant
eduTEAMS OIDC Group management service integrated with research and educational providers provided by Geant
FreeIPA REST API Support for synchronisation of Waldur identities with open-source Identity Management server
Keycloak OIDC Open-source identity management server
LDAP LDAP/S Support of identity servers over LDAP protocol
TARA OIDC Estonian State Autentication service

Ended: Identities

CLI guide

axes_list_attempts

List access attempts

axes_reset

Reset all access attempts and lockouts

axes_reset_failure_logs

Reset access failure log records older than given days.

1
2
3
4
usage: waldur axes_reset_failure_logs [--age AGE]

options:
  --age AGE  Maximum age for records to keep in days

axes_reset_ip

Reset all access attempts and lockouts for given IP addresses

1
2
3
4
usage: waldur axes_reset_ip ip [ip ...]

positional arguments:
  ip

axes_reset_ip_username

Reset all access attempts and lockouts for a given IP address and username

1
2
3
4
5
usage: waldur axes_reset_ip_username ip username

positional arguments:
  ip
  username

axes_reset_logs

Reset access log records older than given days.

1
2
3
4
usage: waldur axes_reset_logs [--age AGE]

options:
  --age AGE  Maximum age for records to keep in days

axes_reset_username

Reset all access attempts and lockouts for given usernames

1
2
3
4
usage: waldur axes_reset_username username [username ...]

positional arguments:
  username

clean_settings_cache

Clean API configuration settings cache.

cleanup_stale_event_types

Cleanup stale event types in all hooks.

copy_category

Copy structure of categories for the Marketplace

1
2
3
4
5
usage: waldur copy_category source_category_uuid target_category_uuid

positional arguments:
  source_category_uuid  UUID of a category to copy metadata from
  target_category_uuid  UUID of a category to copy metadata to

create_provider

Create a service provider with a linked customer and load categories

1
2
3
4
5
usage: waldur create_provider [-n N] [-c C [C ...]]

options:
  -n N          Customer name
  -c C [C ...]  List of categories to load

createstaffuser

Create a user with a specified username and password. User will be created as staff.

1
2
3
4
5
6
usage: waldur createstaffuser -u USERNAME -p PASSWORD -e EMAIL

options:
  -u USERNAME, --username USERNAME
  -p PASSWORD, --password PASSWORD
  -e EMAIL, --email EMAIL

drop_leftover_openstack_projects

Drop leftover projects from remote OpenStack deployment. Leftovers are resources marked as terminated in Waldur but still present in the remote OpenStack. Such inconsistency may be caused by split brain problem in the distributed database.

1
2
3
4
5
6
7
8
9
usage: waldur drop_leftover_openstack_projects [--offering OFFERING]
                                               [--dry-run] [--fuzzy-matching]

options:
  --offering OFFERING  Target marketplace offering name where leftover
                       projects are located.
  --dry-run            Don't make any changes, instead show what projects
                       would be deleted.
  --fuzzy-matching     Try to detect leftovers by name.

drop_stale_permissions

Delete permissions from DB which are no longer in code.

dump_constance_settings

Dump all settings stored in django-constance to a YAML file. This includes all settings, even those with file/image values.

Usage: waldur dump_constance_settings output.yaml

The output format is compatible with override_constance_settings command.

For image/file fields, you can optionally export the actual files to a directory using --export-media option.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
usage: waldur dump_constance_settings [--include-secrets] [--include-defaults]
                                      [--export-media MEDIA_DIR]
                                      output_file

positional arguments:
  output_file           Output file path for YAML dump of constance settings

options:
  --include-secrets     Include sensitive values (passwords, tokens) in the
                        output
  --include-defaults    Include settings that are set to their default values
  --export-media MEDIA_DIR
                        Export media files (logos, images) to this directory

dumpusers

Dumps information about users, their organizations and projects.

1
2
3
4
5
6
usage: waldur dumpusers [-o OUTPUT]

options:
  -o OUTPUT, --output OUTPUT
                        Specifies file to which the output is written. The
                        output will be printed to stdout by default.

export_ami_catalog

Export catalog of Amazon images.

export_auth_social

Export OIDC auth configuration as YAML format

1
2
3
4
5
6
usage: waldur export_auth_social [-o OUTPUT]

options:
  -o OUTPUT, --output OUTPUT
                        Specifies file to which the output is written. The
                        output will be printed to stdout by default.

export_model_metadata

Collect and export metadata about Django models

export_offering

Export an offering from Waldur. Export data includes JSON file with an offering data and a thumbnail. Names of this files include offering ID.

1
2
3
4
5
6
7
usage: waldur export_offering -o OFFERING -p PATH

options:
  -o OFFERING, --offering OFFERING
                        An offering UUID.
  -p PATH, --path PATH  Path to the folder where the export data will be
                        saved.

export_roles

Export roles configuration to YAML format.

This command exports all system roles or optionally only specific roles. The output format is compatible with the import_roles command.

Usage: waldur export_roles roles.yaml waldur export_roles roles.yaml --system-only waldur export_roles roles.yaml --include-inactive

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
usage: waldur export_roles [--system-only] [--include-inactive]
                           [--role-names [ROLE_NAMES ...]]
                           output_file

positional arguments:
  output_file           Output file path for YAML export of roles
                        configuration

options:
  --system-only         Export only system roles (default: all roles)
  --include-inactive    Include inactive roles in export (default: active
                        only)
  --role-names [ROLE_NAMES ...]
                        Export only specific roles by name

generate_mermaid

Generate a Mermaid Class Diagram for specified Django apps and models.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
usage: waldur generate_mermaid [--output OUTPUT_FILE]
                               [--include-models INCLUDE_MODELS]
                               [--exclude-models EXCLUDE_MODELS]
                               [--exclude-field-types EXCLUDE_FIELD_TYPES]
                               [--verbose-names] [--no-inheritance]
                               [--direction {TB,BT,LR,RL}] [--disable-fields]
                               app_label [app_label ...]

positional arguments:
  app_label             Name of the application or applications.

options:
  --output OUTPUT_FILE, -o OUTPUT_FILE
                        Save the diagram to a file.
  --include-models INCLUDE_MODELS, -i INCLUDE_MODELS
                        Models to include (comma-separated, wildcards
                        supported).
  --exclude-models EXCLUDE_MODELS, -e EXCLUDE_MODELS
                        Models to exclude (comma-separated, wildcards
                        supported).
  --exclude-field-types EXCLUDE_FIELD_TYPES
                        Field class names to exclude (e.g.,
                        'TranslationCharField,JsonField').
  --verbose-names       Use model and field verbose_names.
  --no-inheritance      Don't draw inheritance arrows.
  --direction {TB,BT,LR,RL}, -d {TB,BT,LR,RL}
                        Direction of the diagram layout.
  --disable-fields      Don't show fields, only model names and relationships.

import_ami_catalog

Import catalog of Amazon images.

1
2
3
4
5
6
7
usage: waldur import_ami_catalog [-y] FILE

positional arguments:
  FILE       AMI catalog file.

options:
  -y, --yes  The answer to any question which would be asked will be yes.

import_auth_social

Import OIDC auth configuration in YAML format. The example of auth.yaml:

1
2
3
4
5
6
7
8
9
- provider: "keycloak"   # OIDC identity provider in string format. Valid values are: "tara", "eduteams", "keycloak".
  label: "Keycloak"    # Human-readable IdP name.
  client_id: "waldur"   # A string used in OIDC requests for client identification.
  client_secret: OIDC_CLIENT_SECRET
  discovery_url: "http://localhost/auth/realms/YOUR_KEYCLOAK_REALM/.well-known/openid-configuration" # OIDC discovery endpoint.
  management_url: ""   # Endpoint for user details management.
  protected_fields:    # User fields that are imported from IdP.
    - "full_name"
    - "email"

1
2
3
4
usage: waldur import_auth_social auth_file

positional arguments:
  auth_file  Specifies location of auth configuration file.

import_azure_image

Import Azure image

1
2
3
4
5
6
7
usage: waldur import_azure_image [--sku SKU] [--publisher PUBLISHER]
                                 [--offer OFFER]

options:
  --sku SKU
  --publisher PUBLISHER
  --offer OFFER

import_marketplace_orders

Create marketplace order for each resource if it does not yet exist.

import_offering

Import or update an offering in Waldur. You must define offering for updating or category and customer for creating.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
usage: waldur import_offering -p PATH [-c CUSTOMER] [-ct CATEGORY]
                              [-o OFFERING]

options:
  -p PATH, --path PATH  File path to offering data.
  -c CUSTOMER, --customer CUSTOMER
                        Customer UUID.
  -ct CATEGORY, --category CATEGORY
                        Category UUID.
  -o OFFERING, --offering OFFERING
                        Updated offering UUID.

import_reppu_usages

Import component usages from Reppu for a specified year and month.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
usage: waldur import_reppu_usages [-m MONTH] [-y YEAR]
                                  [--reppu-api-url REPPU_API_URL]
                                  [--reppu-api-token REPPU_API_TOKEN]
                                  [--dry-run | --no-dry-run]

options:
  -m MONTH, --month MONTH
                        Month for which data is imported.
  -y YEAR, --year YEAR  Year for which data is imported.
  --reppu-api-url REPPU_API_URL
                        Reppu API URL.
  --reppu-api-token REPPU_API_TOKEN
                        Reppu API Token.
  --dry-run, --no-dry-run
                        Dry run mode.

import_roles

Import roles configuration in YAML format

1
2
3
4
usage: waldur import_roles roles_file

positional arguments:
  roles_file  Specifies location of roles configuration file.

import_tenant_quotas

Import OpenStack tenant quotas to marketplace.

1
2
3
4
5
usage: waldur import_tenant_quotas [--dry-run]

options:
  --dry-run  Don't make any changes, instead show what objects would be
             created.

load_categories

Loads a categories for the Marketplace

1
2
3
4
usage: waldur load_categories category [category ...]

positional arguments:
  category  List of categories to load

load_features

Import features in JSON format

1
2
3
4
5
6
7
8
usage: waldur load_features [--dry-run] features_file

positional arguments:
  features_file  Specifies location of features file.

options:
  --dry-run      Don't make any changes, instead show what objects would be
                 created.

load_notifications

Import notifications to DB

1
2
3
4
usage: waldur load_notifications notifications_file

positional arguments:
  notifications_file  Specifies location of notifications file.

load_user_agreements

Imports privacy policy and terms of service into DB

1
2
3
4
5
6
7
8
usage: waldur load_user_agreements [-tos TOS] [-pp PP] [-f FORCE]

options:
  -tos TOS, --tos TOS   Path to a Terms of service file
  -pp PP, --pp PP       Path to a Privacy policy file
  -f FORCE, --force FORCE
                        This flag means force loading agreements even if they
                        are already defined in DB.

move_project

Move Waldur project to a different organization.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
usage: waldur move_project -p PROJECT_UUID -c CUSTOMER_UUID
                           [--preserve-user-permissions]

options:
  -p PROJECT_UUID, --project PROJECT_UUID
                        UUID of a project to move.
  -c CUSTOMER_UUID, --customer CUSTOMER_UUID
                        Target organization UUID
  --preserve-user-permissions
                        Preserve user permissions

move_resource

Move a marketplace resource to a different project.

1
2
3
4
5
6
7
usage: waldur move_resource -p PROJECT_UUID -r RESOURCE_UUID

options:
  -p PROJECT_UUID, --project PROJECT_UUID
                        Target project UUID
  -r RESOURCE_UUID, --resource RESOURCE_UUID
                        UUID of a marketplace resource to move.

organization_access_subnets

Dumps information about organization access subnets, merging adjacent or overlapping networks.

1
2
3
4
5
6
7
usage: waldur organization_access_subnets [-o OUTPUT]

options:
  -o OUTPUT, --output OUTPUT
                        Specifies file to which the merged subnets will be
                        written. The output will be printed to stdout by
                        default.

override_constance_settings

Override settings stored in django-constance. The example of .yaml file:

1
2
3
4
5
6
7
 - WALDUR_SUPPORT_ENABLED: true # Enables support plugin
  WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE: 'zammad' # Specifies zammad as service desk plugin
  ZAMMAD_API_URL: "https://zammad.example.com/api/" # Specifies zammad API URL
  ZAMMAD_TOKEN: "1282361723491" # Specifies zammad token
  ZAMMAD_GROUP: "default-group" # Specifies zammad group
  ZAMMAD_ARTICLE_TYPE: "email" # Specifies zammad article type
  ZAMMAD_COMMENT_COOLDOWN_DURATION: 7 # Specifies zammad comment cooldown duration

1
2
3
4
5
6
usage: waldur override_constance_settings constance_settings_file

positional arguments:
  constance_settings_file
                        Specifies location of file in YAML format containing
                        new settings

override_roles

Override roles configuration in YAML format. The example of roles-override.yaml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- role: CUSTOMER.OWNER
 description: "Custom owner role"
 is_active: True
 add_permissions:
  - OFFERING.CREATE
  - OFFERING.DELETE
  - OFFERING.UPDATE
 drop_permissions:
  - OFFERING.UPDATE_THUMBNAIL
  - OFFERING.UPDATE_ATTRIBUTES

1
2
3
4
usage: waldur override_roles roles_file

positional arguments:
  roles_file  Specifies location of roles configuration file.

override_templates

Override templates

1
2
3
4
5
6
7
8
9
usage: waldur override_templates [-c CLEAN] templates_file

positional arguments:
  templates_file        Specifies location of templates file.

options:
  -c CLEAN, --clean CLEAN
                        This flag means total synchronization with the
                        template file you pass.

pgmigrate

Load data with disabled signals.

1
2
3
4
usage: waldur pgmigrate [--path PATH]

options:
  --path PATH, -p PATH  Path to dumped database.

print_events_enums

Prints all event types as typescript enums.

print_features_description

Prints all Waldur feature description as typescript code.

print_features_docs

Prints all Waldur feature toggles in markdown format.

print_features_enums

Prints all Waldur feature toggles as typescript enums.

print_mixins

Prints all mixin classes in the codebase in markdown format.

1
2
3
4
5
usage: waldur print_mixins [--output-file OUTPUT_FILE]

options:
  --output-file OUTPUT_FILE
                        Output file path (optional, defaults to stdout)

print_notifications

Prints Mastermind notifications with a description and templates

print_permissions_description

Prints all Waldur permissions description as typescript code.

print_registered_handlers

Prints all registered signal handlers in markdown format.

1
2
3
4
5
6
7
8
usage: waldur print_registered_handlers [--output-file OUTPUT_FILE]
                                        [--handler-type {signals,custom_signals,all}]

options:
  --output-file OUTPUT_FILE
                        Output file path (optional, defaults to stdout)
  --handler-type {signals,custom_signals,all}
                        Type of handlers to collect (default: all)

print_scheduled_jobs

Prints all scheduled background jobs in markdown format.

1
2
3
4
5
usage: waldur print_scheduled_jobs [--output-file OUTPUT_FILE]

options:
  --output-file OUTPUT_FILE
                        Output file path (optional, defaults to stdout)

print_settings_description

Prints all Waldur feature description as typescript code.

pull_openstack_volume_metadata

Pull OpenStack volumes metadata to marketplace.

1
2
3
4
5
usage: waldur pull_openstack_volume_metadata [--dry-run]

options:
  --dry-run  Don't make any changes, instead show what objects would be
             created.

pull_support_priorities

Pull priorities from support backend.

pull_support_users

Pull users from support backend.

push_tenant_quotas

Push OpenStack tenant quotas from marketplace to backend.

1
2
3
4
5
usage: waldur push_tenant_quotas [--dry-run]

options:
  --dry-run  Don't make any changes, instead show what objects would be
             created.

rebuild_billing

Create or update price estimates based on invoices.

removestalect

Remove Django event log records with stale content types.

set_constance_image

A custom command to set Constance image configs with CLI

1
2
3
4
5
usage: waldur set_constance_image KEY PATH

positional arguments:
  KEY   Constance settings key
  PATH  Path to a logo

status

Check status of Waldur MasterMind configured services

switching_backend_server

Backend data update if a server was switched.

sync_saml2_providers

Synchronize SAML2 identity providers.

Configuration options

Static options

WALDUR_AUTH_SAML2 plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
WALDUR_AUTH_SAML2 = {'ALLOW_TO_SELECT_IDENTITY_PROVIDER': True,
 'ATTRIBUTE_MAP_DIR': '/etc/waldur/saml2/attributemaps',
 'AUTHN_REQUESTS_SIGNED': 'true',
 'CATEGORIES': ['http://www.geant.net/uri/dataprotection-code-of-conduct/v1'],
 'CERT_FILE': '',
 'DEBUG': False,
 'DEFAULT_BINDING': 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
 'DESCRIPTION': 'Service provider description',
 'DIGEST_ALGORITHM': None,
 'DISCOVERY_SERVICE_LABEL': None,
 'DISCOVERY_SERVICE_URL': None,
 'DISPLAY_NAME': 'Service provider display name',
 'ENABLE_SINGLE_LOGOUT': False,
 'IDENTITY_PROVIDER_LABEL': None,
 'IDENTITY_PROVIDER_URL': None,
 'IDP_METADATA_LOCAL': [],
 'IDP_METADATA_REMOTE': [],
 'KEY_FILE': '',
 'LOGOUT_REQUESTS_SIGNED': 'true',
 'LOG_FILE': '',
 'LOG_LEVEL': 'INFO',
 'MANAGEMENT_URL': '',
 'NAME': 'saml2',
 'NAMEID_FORMAT': None,
 'OPTIONAL_ATTRIBUTES': [],
 'ORGANIZATION': {},
 'PRIVACY_STATEMENT_URL': 'http://example.com/privacy-policy/',
 'REGISTRATION_AUTHORITY': 'http://example.com/registration-authority/',
 'REGISTRATION_INSTANT': '2017-01-01T00:00:00',
 'REGISTRATION_POLICY': 'http://example.com/registration-policy/',
 'REQUIRED_ATTRIBUTES': [],
 'SAML_ATTRIBUTE_MAPPING': {},
 'SIGNATURE_ALGORITHM': None,
 'XMLSEC_BINARY': '/usr/bin/xmlsec1'}

ALLOW_TO_SELECT_IDENTITY_PROVIDER

Type: bool

ATTRIBUTE_MAP_DIR

Type: str

Directory with attribute mapping

AUTHN_REQUESTS_SIGNED

Type: str

Indicates if the authentication requests sent should be signed by default

CATEGORIES

Type: list

Links to the entity categories

CERT_FILE

Type: str

PEM formatted certificate chain file

DEBUG

Type: bool

Set to True to output debugging information

DEFAULT_BINDING

Type: str

DESCRIPTION

Type: str

Service provider description (required by CoC)

DIGEST_ALGORITHM

Type: Optional[str]

Identifies the Message Digest algorithm URL according to the XML Signature specification (SHA1 is used by default)

DISCOVERY_SERVICE_LABEL

Type: Optional[str]

DISCOVERY_SERVICE_URL

Type: Optional[str]

DISPLAY_NAME

Type: str

Service provider display name (required by CoC)

ENABLE_SINGLE_LOGOUT

Type: bool

IDENTITY_PROVIDER_LABEL

Type: Optional[str]

IDENTITY_PROVIDER_URL

Type: Optional[str]

IDP_METADATA_LOCAL

Type: list

IdPs metadata XML files stored locally

IDP_METADATA_REMOTE

Type: list

IdPs metadata XML files stored remotely

KEY_FILE

Type: str

PEM formatted certificate key file

LOGOUT_REQUESTS_SIGNED

Type: str

Indicates if the entity will sign the logout requests

LOG_FILE

Type: str

Empty to disable logging SAML2-related stuff to file

LOG_LEVEL

Type: str

Log level for SAML2

MANAGEMENT_URL

Type: str

The endpoint for user details management.

NAME

Type: str

Name used for assigning the registration method to the user

NAMEID_FORMAT

Type: Optional[str]

Identified NameID format to use. None means default, empty string ("") disables addition of entity

OPTIONAL_ATTRIBUTES

Type: list

SAML attributes that may be useful to have but not required

ORGANIZATION

Type: dict

Organization responsible for the service (you can set multilanguage information here)

PRIVACY_STATEMENT_URL

Type: str

URL with privacy statement (required by CoC)

REGISTRATION_AUTHORITY

Type: str

Registration authority required by mdpi

REGISTRATION_INSTANT

Type: str

Registration instant time required by mdpi

REGISTRATION_POLICY

Type: str

Registration policy required by mdpi

REQUIRED_ATTRIBUTES

Type: list

SAML attributes that are required to identify a user

SAML_ATTRIBUTE_MAPPING

Type: dict

Mapping between SAML attributes and User fields

SIGNATURE_ALGORITHM

Type: Optional[str]

Identifies the Signature algorithm URL according to the XML Signature specification (SHA1 is used by default)

XMLSEC_BINARY

Type: str

Full path to the xmlsec1 binary program

WALDUR_AUTH_SOCIAL plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
WALDUR_AUTH_SOCIAL = {'ENABLE_EDUTEAMS_SYNC': False,
 'REMOTE_EDUTEAMS_CLIENT_ID': '',
 'REMOTE_EDUTEAMS_ENABLED': False,
 'REMOTE_EDUTEAMS_REFRESH_TOKEN': '',
 'REMOTE_EDUTEAMS_SECRET': '',
 'REMOTE_EDUTEAMS_SSH_API_PASSWORD': '',
 'REMOTE_EDUTEAMS_SSH_API_URL': '',
 'REMOTE_EDUTEAMS_SSH_API_USERNAME': '',
 'REMOTE_EDUTEAMS_TOKEN_URL': 'https://proxy.acc.researcher-access.org/OIDC/token',
 'REMOTE_EDUTEAMS_USERINFO_URL': 'https://proxy.acc.researcher-access.org/api/userinfo'}

ENABLE_EDUTEAMS_SYNC

Type: bool

Enable eduTEAMS synchronization with remote Waldur.

REMOTE_EDUTEAMS_CLIENT_ID

Type: str

ID of application used for OAuth authentication.

REMOTE_EDUTEAMS_ENABLED

Type: bool

Enable remote eduTEAMS extension.

REMOTE_EDUTEAMS_REFRESH_TOKEN

Type: str

Token is used to authenticate against user info endpoint.

REMOTE_EDUTEAMS_SECRET

Type: str

Application secret key.

REMOTE_EDUTEAMS_SSH_API_PASSWORD

Type: str

Password for SSH API URL

REMOTE_EDUTEAMS_SSH_API_URL

Type: str

API URL SSH keys

REMOTE_EDUTEAMS_SSH_API_USERNAME

Type: str

Username for SSH API URL

REMOTE_EDUTEAMS_TOKEN_URL

Type: str

The token endpoint is used to obtain tokens.

REMOTE_EDUTEAMS_USERINFO_URL

Type: str

It allows to get user data based on userid aka CUID.

WALDUR_CORE plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
WALDUR_CORE = {'ATTACHMENT_LINK_MAX_AGE': datetime.timedelta(seconds=3600),
 'AUTHENTICATION_METHODS': ['LOCAL_SIGNIN'],
 'BACKEND_FIELDS_EDITABLE': True,
 'CREATE_DEFAULT_PROJECT_ON_ORGANIZATION_CREATION': False,
 'EMAIL_CHANGE_MAX_AGE': datetime.timedelta(days=1),
 'ENABLE_ACCOUNTING_START_DATE': False,
 'EXTENSIONS_AUTOREGISTER': True,
 'EXTERNAL_LINKS': [],
 'GROUP_INVITATION_LIFETIME': datetime.timedelta(days=7),
 'HOMEPORT_SENTRY_DSN': None,
 'HOMEPORT_SENTRY_ENVIRONMENT': 'waldur-production',
 'HOMEPORT_SENTRY_TRACES_SAMPLE_RATE': 0.01,
 'HTTP_CHUNK_SIZE': 50,
 'INVITATIONS_ENABLED': True,
 'INVITATION_CIVIL_NUMBER_LABEL': '',
 'INVITATION_CREATE_MISSING_USER': False,
 'INVITATION_LIFETIME': datetime.timedelta(days=7),
 'INVITATION_MAX_AGE': None,
 'INVITATION_USE_WEBHOOKS': False,
 'INVITATION_WEBHOOK_TOKEN_CLIENT_ID': '',
 'INVITATION_WEBHOOK_TOKEN_SECRET': '',
 'INVITATION_WEBHOOK_TOKEN_URL': '',
 'INVITATION_WEBHOOK_URL': '',
 'LOCAL_IDP_LABEL': 'Local DB',
 'LOCAL_IDP_MANAGEMENT_URL': '',
 'LOCAL_IDP_NAME': 'Local DB',
 'LOCAL_IDP_PROTECTED_FIELDS': [],
 'LOGGING_REPORT_DIRECTORY': '/var/log/waldur',
 'LOGGING_REPORT_INTERVAL': datetime.timedelta(days=7),
 'MASTERMIND_URL': '',
 'MATOMO_SITE_ID': None,
 'MATOMO_URL_BASE': None,
 'NATIVE_NAME_ENABLED': False,
 'NOTIFICATIONS_PROFILE_CHANGES': {'ENABLE_OPERATOR_OWNER_NOTIFICATIONS': False,
                                   'FIELDS': ('email',
                                              'phone_number',
                                              'job_title'),
                                   'OPERATOR_NOTIFICATION_EMAILS': []},
 'NOTIFICATION_SUBJECT': 'Notifications from Waldur',
 'OECD_FOS_2007_CODE_MANDATORY': False,
 'ONLY_STAFF_CAN_INVITE_USERS': False,
 'PROTECT_USER_DETAILS_FOR_REGISTRATION_METHODS': [],
 'REQUEST_HEADER_IMPERSONATED_USER_UUID': 'HTTP_X_IMPERSONATED_USER_UUID',
 'RESPONSE_HEADER_IMPERSONATOR_UUID': 'X-impersonator-uuid',
 'SELLER_COUNTRY_CODE': None,
 'SERVICE_ACCOUNT_TOKEN_CLIENT_ID': '',
 'SERVICE_ACCOUNT_TOKEN_SECRET': '',
 'SERVICE_ACCOUNT_TOKEN_URL': '',
 'SERVICE_ACCOUNT_URL': '',
 'SERVICE_ACCOUNT_USE_API': False,
 'SUBNET_BLACKLIST': ['10.0.0.0/8',
                      '172.16.0.0/12',
                      '192.168.0.0/16',
                      '169.254.0.0/16',
                      '127.0.0.0/8',
                      '::1/128',
                      'fc00::/7',
                      'fe80::/10'],
 'SUPPORT_PORTAL_URL': '',
 'TOKEN_LIFETIME': datetime.timedelta(seconds=3600),
 'TRANSLATION_DOMAIN': '',
 'USER_MANDATORY_FIELDS': ['first_name', 'last_name', 'email'],
 'USER_REGISTRATION_HIDDEN_FIELDS': ['registration_method',
                                     'job_title',
                                     'phone_number',
                                     'organization'],
 'USE_ATOMIC_TRANSACTION': True,
 'VALIDATE_INVITATION_EMAIL': False}

Type: timedelta

Max age of secure token for media download.

AUTHENTICATION_METHODS

Type: List[str]

List of enabled authentication methods.

BACKEND_FIELDS_EDITABLE

Type: bool

Allows to control /admin writable fields. If this flag is disabled it is impossible to edit any field that corresponds to backend value via /admin. Such restriction allows to save information from corruption.

CREATE_DEFAULT_PROJECT_ON_ORGANIZATION_CREATION

Type: bool

Enables generation of the first project on organization creation.

EMAIL_CHANGE_MAX_AGE

Type: timedelta

Max age of change email request.

ENABLE_ACCOUNTING_START_DATE

Type: bool

Allows to enable accounting for organizations using value of accounting_start_date field.

EXTENSIONS_AUTOREGISTER

Type: bool

Defines whether extensions should be automatically registered.

Type: List[ExternalLink]

Render external links in dropdown in header. Each item should be object with label and url fields. For example: {"label": "Helpdesk", "url": "https://example.com/"}

GROUP_INVITATION_LIFETIME

Type: timedelta

Defines for how long group invitation remains valid.

HOMEPORT_SENTRY_DSN

Type: Optional[str]

Sentry Data Source Name for Waldur HomePort project.

HOMEPORT_SENTRY_ENVIRONMENT

Type: str

Sentry environment name for Waldur Homeport.

HOMEPORT_SENTRY_TRACES_SAMPLE_RATE

Type: float

Percentage of transactions sent to Sentry for tracing.

HTTP_CHUNK_SIZE

Type: int

Chunk size for resource fetching from backend API. It is needed in order to avoid too long HTTP request error.

INVITATIONS_ENABLED

Type: bool

Allows to disable invitations feature.

INVITATION_CIVIL_NUMBER_LABEL

Type: str

Custom label for civil number field in invitation creation dialog.

INVITATION_CREATE_MISSING_USER

Type: bool

Allow to create FreeIPA user using details specified in invitation if user does not exist yet.

INVITATION_LIFETIME

Type: timedelta

Defines for how long invitation remains valid.

INVITATION_MAX_AGE

Type: Optional[timedelta]

Max age of invitation token. It is used in approve and reject actions.

INVITATION_USE_WEBHOOKS

Type: bool

Allow sending of webhooks instead of sending of emails.

INVITATION_WEBHOOK_TOKEN_CLIENT_ID

Type: str

Client ID to get access token from Keycloak.

INVITATION_WEBHOOK_TOKEN_SECRET

Type: str

Client secret to get access token from Keycloak.

INVITATION_WEBHOOK_TOKEN_URL

Type: str

Keycloak URL to get access token.

INVITATION_WEBHOOK_URL

Type: str

Webhook URL for sending invitations.

LOCAL_IDP_LABEL

Type: str

The label of local auth.

LOCAL_IDP_MANAGEMENT_URL

Type: str

The URL for management of local user details.

LOCAL_IDP_NAME

Type: str

The name of local auth.

LOCAL_IDP_PROTECTED_FIELDS

Type: List[str]

The list of protected fields for local IdP.

LOGGING_REPORT_DIRECTORY

Type: str

Directory where log files are located.

LOGGING_REPORT_INTERVAL

Type: timedelta

Files older that specified interval are filtered out.

MASTERMIND_URL

Type: str

It is used for rendering callback URL in MasterMind.

MATOMO_SITE_ID

Type: Optional[int]

Site ID is used by Matomo analytics application.

MATOMO_URL_BASE

Type: Optional[str]

URL base is used by Matomo analytics application.

NATIVE_NAME_ENABLED

Type: bool

Allows to render native name field in customer and user forms.

NOTIFICATIONS_PROFILE_CHANGES

Type: dict

Configure notifications about profile changes of organization owners.

NOTIFICATION_SUBJECT

Type: str

It is used as a subject of email emitted by event logging hook.

OECD_FOS_2007_CODE_MANDATORY

Type: bool

Field oecd_fos_2007_code must be required for project.

ONLY_STAFF_CAN_INVITE_USERS

Type: bool

Allow to limit invitation management to staff only.

PROTECT_USER_DETAILS_FOR_REGISTRATION_METHODS

Type: List[str]

List of authentication methods for which a manual update of user details is not allowed.

REQUEST_HEADER_IMPERSONATED_USER_UUID

Type: str

The request header, which contains the user UUID of the user to be impersonated.

RESPONSE_HEADER_IMPERSONATOR_UUID

Type: str

The response header, which contains the UUID of the user who requested the impersonation.

SELLER_COUNTRY_CODE

Type: Optional[str]

Specifies seller legal or effective country of registration or residence as an ISO 3166-1 alpha-2 country code. It is used for computing VAT charge rate.

SERVICE_ACCOUNT_TOKEN_CLIENT_ID

Type: str

Client ID to get access token for service account.

SERVICE_ACCOUNT_TOKEN_SECRET

Type: str

Client secret to get access for service account.

SERVICE_ACCOUNT_TOKEN_URL

Type: str

Webhook URL for getting token for further service account management.

SERVICE_ACCOUNT_URL

Type: str

Webhook URL for service account management.

SERVICE_ACCOUNT_USE_API

Type: bool

Send service account creation and deletion requests to API.

SUBNET_BLACKLIST

Type: List[str]

List of IP ranges that are blocked for the SDK client.

SUPPORT_PORTAL_URL

Type: str

Support portal URL is rendered as a shortcut on dashboard

TOKEN_LIFETIME

Type: timedelta

Defines for how long user token should remain valid if there was no action from user.

TRANSLATION_DOMAIN

Type: str

Identifier of translation domain applied to current deployment.

USER_MANDATORY_FIELDS

Type: List[str]

List of user profile attributes that would be required for filling in HomePort. Note that backend will not be affected. If a mandatory field is missing in profile, a profile edit view will be forced upon user on any HomePort logged in action. Possible values are: description, email, full_name, job_title, organization, phone_number

USER_REGISTRATION_HIDDEN_FIELDS

Type: List[str]

List of user profile attributes that would be concealed on registration form in HomePort. Possible values are: job_title, registration_method, phone_number

USE_ATOMIC_TRANSACTION

Type: bool

Wrap action views in atomic transaction.

VALIDATE_INVITATION_EMAIL

Type: bool

Ensure that invitation and user emails match.

WALDUR_HPC plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
WALDUR_HPC = {'ENABLED': False,
 'EXTERNAL_AFFILIATIONS': [],
 'EXTERNAL_CUSTOMER_UUID': '',
 'EXTERNAL_EMAIL_PATTERNS': [],
 'EXTERNAL_LIMITS': {},
 'INTERNAL_AFFILIATIONS': [],
 'INTERNAL_CUSTOMER_UUID': '',
 'INTERNAL_EMAIL_PATTERNS': [],
 'INTERNAL_LIMITS': {},
 'OFFERING_UUID': '',
 'PLAN_UUID': ''}

ENABLED

Type: bool

Enable HPC-specific hooks in Waldur deployment

EXTERNAL_AFFILIATIONS

Type: List[str]

List of user affiliations (eduPersonScopedAffiliation fields) that define if the user belongs to external organization.

EXTERNAL_CUSTOMER_UUID

Type: str

UUID of a Waldur organization (aka customer) where new external users would be added

EXTERNAL_EMAIL_PATTERNS

Type: List[str]

List of user email patterns (as regex) that define if the user belongs to external organization.

EXTERNAL_LIMITS

Type: dict

Overrided default values for SLURM offering to be created for users belonging to external organization.

INTERNAL_AFFILIATIONS

Type: List[str]

List of user affiliations (eduPersonScopedAffiliation fields) that define if the user belongs to internal organization.

INTERNAL_CUSTOMER_UUID

Type: str

UUID of a Waldur organization (aka customer) where new internal users would be added

INTERNAL_EMAIL_PATTERNS

Type: List[str]

List of user email patterns (as regex) that define if the user belongs to internal organization.

INTERNAL_LIMITS

Type: dict

Overrided default values for SLURM offering to be created for users belonging to internal organization.

OFFERING_UUID

Type: str

UUID of a Waldur SLURM offering, which will be used for creating allocations for users

PLAN_UUID

Type: str

UUID of a Waldur SLURM offering plan, which will be used for creating allocations for users

WALDUR_OPENSTACK plugin

Default value:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
WALDUR_OPENSTACK = {'ALLOW_CUSTOMER_USERS_OPENSTACK_CONSOLE_ACCESS': True,
 'ALLOW_DIRECT_EXTERNAL_NETWORK_CONNECTION': False,
 'DEFAULT_BLACKLISTED_USERNAMES': ['admin', 'service'],
 'DEFAULT_SECURITY_GROUPS': ({'description': 'Security group for secure shell '
                                             'access',
                              'name': 'ssh',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'from_port': 22,
                                         'protocol': 'tcp',
                                         'to_port': 22},)},
                             {'description': 'Security group for ping',
                              'name': 'ping',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'icmp_code': -1,
                                         'icmp_type': -1,
                                         'protocol': 'icmp'},)},
                             {'description': 'Security group for remote '
                                             'desktop access',
                              'name': 'rdp',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'from_port': 3389,
                                         'protocol': 'tcp',
                                         'to_port': 3389},)},
                             {'description': 'Security group for http and '
                                             'https access',
                              'name': 'web',
                              'rules': ({'cidr': '0.0.0.0/0',
                                         'from_port': 80,
                                         'protocol': 'tcp',
                                         'to_port': 80},
                                        {'cidr': '0.0.0.0/0',
                                         'from_port': 443,
                                         'protocol': 'tcp',
                                         'to_port': 443})}),
 'MAX_CONCURRENT_PROVISION': {'OpenStack.Instance': 4,
                              'OpenStack.Snapshot': 4,
                              'OpenStack.Volume': 4},
 'REQUIRE_AVAILABILITY_ZONE': False,
 'SUBNET': {'ALLOCATION_POOL_END': '{first_octet}.{second_octet}.{third_octet}.200',
            'ALLOCATION_POOL_START': '{first_octet}.{second_octet}.{third_octet}.10'},
 'TENANT_CREDENTIALS_VISIBLE': False}

ALLOW_CUSTOMER_USERS_OPENSTACK_CONSOLE_ACCESS

Type: bool

If true, customer users would be offered actions for accessing OpenStack console

ALLOW_DIRECT_EXTERNAL_NETWORK_CONNECTION

Type: bool

If true, allow connecting of instances directly to external networks

DEFAULT_BLACKLISTED_USERNAMES

Type: list

Usernames that cannot be created by Waldur in OpenStack

DEFAULT_SECURITY_GROUPS

Type: tuple

Default security groups and rules created in each of the provisioned OpenStack tenants

MAX_CONCURRENT_PROVISION

Type: dict

Maximum parallel executions of provisioning operations for OpenStack resources

REQUIRE_AVAILABILITY_ZONE

Type: bool

If true, specification of availability zone during provisioning will become mandatory

SUBNET

Type: dict

Default allocation pool for auto-created internal network

TENANT_CREDENTIALS_VISIBLE

Type: bool

If true, generated credentials of a tenant are exposed to project users

WALDUR_PID plugin

Default value:

1
2
3
4
5
6
WALDUR_PID = {'DATACITE': {'API_URL': 'https://example.com',
              'COLLECTION_DOI': '',
              'PASSWORD': '',
              'PREFIX': '',
              'PUBLISHER': 'Waldur',
              'REPOSITORY_ID': ''}}

DATACITE

Type: dict

Settings for integration of Waldur with Datacite PID service. Collection DOI is used to aggregate generated DOIs.

WALDUR_SLURM plugin

Default value:

1
2
3
4
5
6
WALDUR_SLURM = {'ALLOCATION_PREFIX': 'waldur_allocation_',
 'CUSTOMER_PREFIX': 'waldur_customer_',
 'DEFAULT_LIMITS': {'CPU': 16000, 'GPU': 400, 'RAM': 102400000},
 'ENABLED': False,
 'PRIVATE_KEY_PATH': '/etc/waldur/id_rsa',
 'PROJECT_PREFIX': 'waldur_project_'}

ALLOCATION_PREFIX

Type: str

Prefix for SLURM account name corresponding to Waldur allocation

CUSTOMER_PREFIX

Type: str

Prefix for SLURM account name corresponding to Waldur organization.

DEFAULT_LIMITS

Type: dict

Default limits of account that are set when SLURM account is provisioned.

ENABLED

Type: bool

Enable support for SLURM plugin in a deployment

PRIVATE_KEY_PATH

Type: str

Path to private key file used as SSH identity file for accessing SLURM master.

PROJECT_PREFIX

Type: str

Prefix for SLURM account name corresponding to Waldur project.

Other variables

DEFAULT_FROM_EMAIL

Type: str, default value: webmaster@localhost

Default email address to use for automated correspondence from Waldur.

DEFAULT_REPLY_TO_EMAIL

Type: str

Default email address to use for email replies.

EMAIL_HOOK_FROM_EMAIL

Type: str

Alternative email address to use for email hooks.

IMPORT_EXPORT_USE_TRANSACTIONS

Type: bool, default value: True

Controls if resource importing should use database transactions. Using transactions makes imports safer as a failure during import won’t import only part of the data set.

IPSTACK_ACCESS_KEY

Type: Optional[str]

Unique authentication key used to gain access to the ipstack API.

LANGUAGES

Type: List[tuple[str, str]], default value: (('en', 'English'), ('et', 'Eesti'))

The list is a list of two-tuples in the format (language code, language name) – for example, ('ja', 'Japanese').

LANGUAGE_CODE

Type: str, default value: en

Represents the name of a default language.

VERIFY_WEBHOOK_REQUESTS

Type: bool, default value: True

When webook is processed, requests verifies SSL certificates for HTTPS requests, just like a web browser.

Dynamic options

Branding

SITE_NAME

Type: str

Default value: Waldur

Human-friendly name of the Waldur deployment.

SHORT_PAGE_TITLE

Type: str

Default value: Waldur

It is used as prefix for page title.

FULL_PAGE_TITLE

Type: str

Default value: Waldur | Cloud Service Management

It is used as default page title if it's not specified explicitly.

SITE_DESCRIPTION

Type: str

Default value: Your single pane of control for managing projects, teams and resources in a self-service manner.

Description of the Waldur deployment.

HOMEPORT_URL

Type: str

Default value: https://example.com/

It is used for rendering callback URL in HomePort

RANCHER_USERNAME_INPUT_LABEL

Type: str

Default value: Username

Label for the username field in Rancher external user resource access management.

Marketplace Branding

SITE_ADDRESS

Type: str

It is used in marketplace order header.

SITE_EMAIL

Type: str

It is used in marketplace order header and UI footer.

SITE_PHONE

Type: str

It is used in marketplace order header and UI footer.

CURRENCY_NAME

Type: str

Default value: EUR

It is used in marketplace order details and invoices for currency formatting.

MARKETPLACE_LANDING_PAGE

Type: str

Default value: Marketplace

Marketplace landing page title.

COUNTRIES

Type: country_list_field

Default value: ['AL', 'AT', 'BA', 'BE', 'BG', 'CH', 'CY', 'CZ', 'DE', 'DK', 'EE', 'ES', 'EU', 'FI', 'FR', 'GB', 'GE', 'GR', 'HR', 'HU', 'IE', 'IS', 'IT', 'LT', 'LU', 'LV', 'MC', 'MK', 'MT', 'NL', 'NO', 'PL', 'PT', 'RO', 'RS', 'SE', 'SI', 'SK', 'UA']

It is used in organization creation dialog in order to limit country choices to predefined set.

Marketplace

THUMBNAIL_SIZE

Type: str

Default value: 120x120

Size of the thumbnail to generate when screenshot is uploaded for an offering.

ANONYMOUS_USER_CAN_VIEW_OFFERINGS

Type: bool

Default value: True

Allow anonymous users to see shared offerings in active, paused and archived states

ANONYMOUS_USER_CAN_VIEW_PLANS

Type: bool

Default value: True

Allow anonymous users to see plans

NOTIFY_STAFF_ABOUT_APPROVALS

Type: bool

If true, users with staff role are notified when request for order approval is generated

NOTIFY_ABOUT_RESOURCE_CHANGE

Type: bool

Default value: True

If true, notify users about resource changes from Marketplace perspective. Can generate duplicate events if plugins also log

DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE

Type: bool

Default value: True

Disable only resource update events.

ENABLE_STALE_RESOURCE_NOTIFICATIONS

Type: bool

Enable reminders to owners about resources of shared offerings that have not generated any cost for the last 3 months.

ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND

Type: bool

Enable mock returns for the service account service

Type: bool

If True, users must have active consent to access offerings that have active Terms of Service.

Telemetry

TELEMETRY_URL

Type: str

Default value: https://telemetry.waldur.com/

URL for sending telemetry data.

TELEMETRY_VERSION

Type: int

Default value: 1

Telemetry service version.

Custom Scripts

SCRIPT_RUN_MODE

Type: str

Default value: docker

Type of jobs deployment. Valid values: "docker" for simple docker deployment, "k8s" for Kubernetes-based one

DOCKER_CLIENT

Type: dict_field

Default value: {'base_url': 'unix:///var/run/docker.sock'}

Options for docker client. See also: https://docker-py.readthedocs.io/en/stable/client.html#docker.client.DockerClient

DOCKER_RUN_OPTIONS

Type: dict_field

Default value: {'mem_limit': '512m'}

Options for docker runtime. See also: https://docker-py.readthedocs.io/en/stable/containers.html#docker.models.containers.ContainerCollection.run

DOCKER_SCRIPT_DIR

Type: str

Path to folder on executor machine where to create temporary submission scripts. If None, uses OS-dependent location. OS X users, see https://github.com/docker/for-mac/issues/1532

DOCKER_REMOVE_CONTAINER

Type: bool

Default value: True

Remove Docker container after script execution

DOCKER_IMAGES

Type: dict_field

Default value: {'python': {'image': 'python:3.11-alpine', 'command': 'python'}, 'shell': {'image': 'alpine:3', 'command': 'sh'}, 'ansible': {'image': 'alpine/ansible:2.18.6', 'command': 'ansible-playbook'}}

Key is command to execute script, value is a dictionary of image name and command.

DOCKER_VOLUME_NAME

Type: str

Default value: waldur-docker-compose_waldur_script_launchzone

A name of the shared volume to store scripts

K8S_NAMESPACE

Type: str

Default value: default

Kubernetes namespace where jobs will be executed

K8S_CONFIG_PATH

Type: str

Default value: ~/.kube/config

Path to Kubernetes configuration file

K8S_JOB_TIMEOUT

Type: int

Default value: 1800

Timeout for execution of one Kubernetes job in seconds

Notifications

COMMON_FOOTER_TEXT

Type: text_field

Common footer in txt format for all emails.

Type: html_field

Common footer in html format for all emails.

MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES

Type: int

Default value: 60

How many minutes before scheduled maintenance users should be notified.

MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM

Type: list_field

Default value: ['AdminAnnouncement']

How maintenance notifications are delivered. Choices: AdminAnnouncement or BroadcastMessage.

DOCS_URL

Type: url_field

Renders link to docs in header

Type: str

Label for link in hero section of HomePort landing page. It can be lead to support site or blog post.

Type: url_field

Link URL in hero section of HomePort landing page.

SUPPORT_PORTAL_URL

Type: url_field

Link URL to support portal. Rendered as a shortcut on dashboard

Theme

SIDEBAR_STYLE

Type: str

Default value: dark

Style of sidebar. Possible values: dark, light, accent.

BRAND_COLOR

Type: color_field

Default value: #307300

Brand color is used for button background.

DISABLE_DARK_THEME

Type: bool

Toggler to disable dark theme.

Images

Type: image_field

The image used in marketplace order header.

Type: image_field

The image rendered at the top of sidebar menu in HomePort.

SIDEBAR_LOGO_MOBILE

Type: image_field

The image rendered at the top of mobile sidebar menu in HomePort.

SIDEBAR_LOGO_DARK

Type: image_field

The image rendered at the top of sidebar menu in dark mode.

Type: image_field

The image rendered at the bottom of login menu in HomePort.

HERO_IMAGE

Type: image_field

The image rendered at hero section of HomePort landing page.

MARKETPLACE_HERO_IMAGE

Type: image_field

The image rendered at hero section of Marketplace landing page. Please, use a wide image (min. 1920×600px) with no text or logos. Keep the center area clean, and choose a darker image for dark mode or a brighter image for light mode.

CALL_MANAGEMENT_HERO_IMAGE

Type: image_field

The image rendered at hero section of Call Management landing page. Please, use a wide image (min. 1920×600px) with no text or logos. Keep the center area clean, and choose a darker image for dark mode or a brighter image for light mode.

Type: image_field

A custom .png image file for login page

FAVICON

Type: image_field

A custom favicon .png image file

OFFERING_LOGO_PLACEHOLDER

Type: image_field

Default logo for offering

KEYCLOAK_ICON

Type: image_field

A custom PNG icon for Keycloak login button

Service desk integration settings

WALDUR_SUPPORT_ENABLED

Type: bool

Default value: True

Toggler for support plugin.

WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE

Type: str

Default value: atlassian

Type of support backend. Possible values: atlassian, zammad, smax.

WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE

Type: bool

Default value: True

Toggler for request type displaying

Atlassian settings

ATLASSIAN_API_URL

Type: url_field

Default value: https://example.com/

Atlassian API server URL

ATLASSIAN_USERNAME

Type: str

Default value: USERNAME

Username for access user

ATLASSIAN_PASSWORD

Type: secret_field

Default value: PASSWORD

Password for access user

ATLASSIAN_EMAIL

Type: email_field

Email for access user

ATLASSIAN_TOKEN

Type: secret_field

Token for access user

ATLASSIAN_PROJECT_ID

Type: str

Service desk ID or key

ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE

Type: str

Default value: Service Request

Issue type used for request-based item processing.

ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES

Type: str

Comma-separated list of file extenstions not allowed for attachment.

ATLASSIAN_ISSUE_TYPES

Type: str

Default value: Informational, Service Request, Change Request, Incident

Comma-separated list of enabled issue types. First type is the default one.

ATLASSIAN_AFFECTED_RESOURCE_FIELD

Type: str

Affected resource field name

ATLASSIAN_DESCRIPTION_TEMPLATE

Type: str

Template for issue description

ATLASSIAN_SUMMARY_TEMPLATE

Type: str

Template for issue summary

ATLASSIAN_IMPACT_FIELD

Type: str

Default value: Impact

Impact field name

ATLASSIAN_ORGANISATION_FIELD

Type: str

Organisation field name

ATLASSIAN_RESOLUTION_SLA_FIELD

Type: str

Resolution SLA field name

ATLASSIAN_PROJECT_FIELD

Type: str

Project field name

ATLASSIAN_REPORTER_FIELD

Type: str

Default value: Original Reporter

Reporter field name

ATLASSIAN_CALLER_FIELD

Type: str

Default value: Caller

Caller field name

ATLASSIAN_SLA_FIELD

Type: str

Default value: Time to first response

SLA field name

ATLASSIAN_LINKED_ISSUE_TYPE

Type: str

Default value: Relates

Type of linked issue field name

ATLASSIAN_SATISFACTION_FIELD

Type: str

Default value: Customer satisfaction

Customer satisfaction field name

ATLASSIAN_REQUEST_FEEDBACK_FIELD

Type: str

Default value: Request feedback

Request feedback field name

ATLASSIAN_TEMPLATE_FIELD

Type: str

Template field name

ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED

Type: bool

Default value: True

Should extra issue field mappings be applied

ATLASSIAN_SHARED_USERNAME

Type: bool

Is Service Desk username the same as in Waldur

ATLASSIAN_VERIFY_SSL

Type: bool

Default value: True

Toggler for SSL verification

ATLASSIAN_USE_OLD_API

Type: bool

Toggler for legacy API usage.

ATLASSIAN_USE_TEENAGE_API

Type: bool

Toggler for teenage API usage.

ATLASSIAN_USE_AUTOMATIC_REQUEST_MAPPING

Type: bool

Default value: True

Toggler for automatic request mapping.

ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS

Type: bool

Toggler for mapping between waldur user and service desk agents.

ATLASSIAN_STRANGE_SETTING

Type: int

Default value: 1

A constant in the API path, sometimes differs

ATLASSIAN_PULL_PRIORITIES

Type: bool

Default value: True

Toggler for pulling priorities from backend

Zammad settings

ZAMMAD_API_URL

Type: url_field

Zammad API server URL. For example https://localhost:8080/

ZAMMAD_TOKEN

Type: secret_field

Authorization token.

ZAMMAD_GROUP

Type: str

The name of the group to which the ticket will be added. If not specified, the first group will be used.

ZAMMAD_ARTICLE_TYPE

Type: str

Default value: email

Type of a comment. Default is email because it allows support to reply to tickets directly in Zammadhttps://docs.zammad.org/en/latest/api/ticket/articles.html#articles/

ZAMMAD_COMMENT_MARKER

Type: str

Default value: Created by Waldur

Marker for comment. Used for separating comments made via Waldur from natively added comments.

ZAMMAD_COMMENT_PREFIX

Type: str

Default value: User: {name}

Comment prefix with user info.

ZAMMAD_COMMENT_COOLDOWN_DURATION

Type: int

Default value: 5

Time in minutes. Time in minutes while comment deletion is available https://github.com/zammad/zammad/issues/2687/, https://github.com/zammad/zammad/issues/3086/

SMAX settings

SMAX_API_URL

Type: url_field

SMAX API server URL. For example https://localhost:8080/

SMAX_TENANT_ID

Type: str

User tenant ID.

SMAX_LOGIN

Type: str

Authorization login.

SMAX_PASSWORD

Type: secret_field

Authorization password.

SMAX_ORGANISATION_FIELD

Type: str

Organisation field name.

SMAX_PROJECT_FIELD

Type: str

Project field name.

SMAX_AFFECTED_RESOURCE_FIELD

Type: str

Resource field name.

SMAX_REQUESTS_OFFERING

Type: str

Requests offering code for all issues.

SMAX_SECONDS_TO_WAIT

Type: int

Default value: 1

Duration in seconds of delay between pull user attempts.

SMAX_TIMES_TO_PULL

Type: int

Default value: 10

The maximum number of attempts to pull user from backend.

SMAX_CREATION_SOURCE_NAME

Type: str

Creation source name.

SMAX_VERIFY_SSL

Type: bool

Default value: True

Toggler for SSL verification

Proposal settings

PROPOSAL_REVIEW_DURATION

Type: int

Default value: 7

Review duration in days.

Table settings

USER_TABLE_COLUMNS

Type: str

Comma-separated list of columns for users table.

Localization

LANGUAGE_CHOICES

Type: str

Default value: en,et,lt,lv,ru,it,de,da,sv,es,fr,nb,ar,cs

List of enabled languages

User settings

AUTO_APPROVE_USER_TOS

Type: bool

Mark terms of services as approved for new users.

ENABLE_STRICT_CHECK_ACCEPTING_INVITATION

Type: bool

If true, user email in Waldur database and in invitatation must strictly match.

INVITATION_DISABLE_MULTIPLE_ROLES

Type: bool

Do not allow user to grant multiple roles in the same project or organization using invitation.

DEFAULT_IDP

Type: str

Triggers authentication flow at once.

DEACTIVATE_USER_IF_NO_ROLES

Type: bool

Deactivate user if all roles are revoked (except staff/support)

FreeIPA settings

FREEIPA_ENABLED

Type: bool

Enable integration of identity provisioning in configured FreeIPA.

FREEIPA_HOSTNAME

Type: str

Default value: ipa.example.com

Hostname of FreeIPA server.

FREEIPA_USERNAME

Type: str

Default value: admin

Username of FreeIPA user with administrative privileges.

FREEIPA_PASSWORD

Type: secret_field

Default value: secret

Password of FreeIPA user with administrative privileges

FREEIPA_VERIFY_SSL

Type: bool

Default value: True

Validate TLS certificate of FreeIPA web interface / REST API

FREEIPA_USERNAME_PREFIX

Type: str

Default value: waldur_

Prefix to be appended to all usernames created in FreeIPA by Waldur

FREEIPA_GROUPNAME_PREFIX

Type: str

Default value: waldur_

Prefix to be appended to all group names created in FreeIPA by Waldur

FREEIPA_BLACKLISTED_USERNAMES

Type: list_field

Default value: ['root']

List of username that users are not allowed to select

FREEIPA_GROUP_SYNCHRONIZATION_ENABLED

Type: bool

Default value: True

Optionally disable creation of user groups in FreeIPA matching Waldur structure

OIDC auth settings

OIDC_AUTH_URL

Type: str

OIDC authentication endpoint URL.

OIDC_INTROSPECTION_URL

Type: str

OIDC introspection endpoint URL for validating access tokens.

OIDC_CLIENT_ID

Type: str

Client ID for authenticating against the introspection endpoint.

OIDC_CLIENT_SECRET

Type: str

Client secret for authenticating against the introspection endpoint.

OIDC_USER_FIELD

Type: str

Default value: username

Field name from the introspection response to identify the user (e.g., 'username', 'email', 'client_id').

OIDC_CACHE_TIMEOUT

Type: int

Default value: 300

Number of seconds to cache token introspection results.

Features

customer.payments_for_staff_only

Make payments menu visible for staff users only.

customer.show_domain

Allows to hide domain field in organization detail.

customer.show_permission_reviews

Allows to show permission reviews tab and popups.

Enable cookie notice in marketplace.

deployment.send_metrics

Send telemetry metrics.

invitations.civil_number_required

Make civil number field mandatory in invitation creation form.

invitations.conceal_civil_number

Conceal civil number in invitation creation dialog.

invitations.show_service_accounts

Show service accounts of the scopes.

marketplace.call_only

Allow marketplace to serve only as aggregator of call info.

marketplace.catalogue_only

Allow marketplace to function as a catalogue only.

marketplace.conceal_prices

Do not render prices in order details.

marketplace.import_resources

Allow to import resources from service provider to project.

Enabled LEXIS link integrations for offerings.

marketplace.show_call_management_functionality

Enabled display of call management functionality.

marketplace.show_experimental_ui_components

Enabled display of experimental or mocked components in marketplace.

marketplace.show_resource_end_date

Show resource end date as a non optional column in resources list.

openstack.hide_volume_type_selector

Allow to hide OpenStack volume type selector when instance or volume is provisioned.

openstack.show_migrations

Show OpenStack tenant migrations action and tab

project.estimated_cost

Render estimated cost column in projects list.

project.mandatory_end_date

Make the project end date mandatory.

project.mandatory_start_date

Make the project start date mandatory.

project.oecd_fos_2007_code

Enable OECD code.

project.show_credit_in_create_dialog

Show credit field in project create dialog.

project.show_description_in_create_dialog

Show description field in project create dialog.

project.show_end_date_in_create_dialog

Show end date field in project create dialog.

project.show_image_in_create_dialog

Show image field in project create dialog.

project.show_industry_flag

Show industry flag.

project.show_start_date_in_create_dialog

Show start date field in project create dialog.

project.show_type_in_create_dialog

Show type field in project create dialog.

rancher.apps

Render Rancher apps as a separate tab in resource details page.

rancher.volume_mount_point

Allow to select mount point for data volume when Rancher cluster is provisioned.

slurm.jobs

Render list of SLURM jobs as a separate tab in allocation details page.

support.conceal_change_request

Conceal "Change request" from a selection of issue types for non-staff/non-support users.

support.pricelist

Render marketplace plan components pricelist in support workspace.

support.vm_type_overview

Enable VM type overview in support workspace.

user.disable_user_termination

Disable user termination in user workspace.

user.notifications

Enable email and webhook notifications management in user workspace.

user.preferred_language

Render preferred language column in users list.

user.show_slug

Enable display of slug field in user summary.

user.show_username

Enable display of username field in user tables.

user.ssh_keys

Enable SSH keys management in user workspace.

General Configuration

Outline:

Introduction

Waldur is a Django-based application, so configuration is done by modifying settings.py file.

If you want to configure options related to Django, such as tune caches, database connection, configure custom logging, etc, please refer to Django documentation.

Please consult configuration guide to learn more.

Admin dashboard configuration

An admin dashboard supports custom links on Quick access panel. For instance, a panel below was configured with one additional link to https://waldur.com:

admin example

Configuration of custom links is stored under FLUENT_DASHBOARD_QUICK_ACCESS_LINKS settings key and for current example has following structure:

1
2
3
4
5
6
7
8
9
FLUENT_DASHBOARD_QUICK_ACCESS_LINKS = [
  {
   'title': '[Custom] Waldur - Cloud Service',
   'url': 'https://waldur.com',
   'external': True, # adds an icon specifying that this link is external,
   'description': 'Open-source Cloud Brokerage Platform',
   'attrs': {'target': '_blank'} # add an attribute to generated anchor element which will open link in a new tab.
  },
]

Here is a short description of link parameters:

Name Type Required Description
description string No Tool tip on the link
external boolean No Specifies whether additional icon indicating an external URL has to be added
url URL Yes A URL of the link
title string Yes A title of the generated link
attrs dict No A dictionary of anchor attributes to be added to generated element

It is also possible to omit optional fields and add links by specifying only a title and a URL to the generated link.

1
2
3
4
FLUENT_DASHBOARD_QUICK_ACCESS_LINKS = [
  ['[Custom] Waldur - Cloud Service', 'https://waldur.com'],
  ['Find us on GitHub', 'https://github.com/opennode/waldur-core'],
]

Custom templates configuration

To overwrite default templates you should use django-dbtemplates. It allows creation of templates through /admin.

Local time zone configuration

Set TIME_ZONE setting in /etc/waldur/override.conf.py to use local time zone. By default it is set to UTC. See the list of time zones for possible options.

Configuration of the Google Calendar

Overriding notification templates via admin panel

An admin can override(edit the content) the templates of notifications with the following sequence of actions:

  • Go to admin panel (e.g. http://localhost:8080/admin/)

  • Open Templates: Utilities -> Database templates -> Templates

Go to admin panel

  • Click on Add template on the right side.

Go to admin panel

  • Enter the path to the template file into the Name input field as shown below.

    The name should have a <waldur_application_name>/<event_name>_<postfix>.<extension> format, where <postfix> can be either message or subject, and <extension> - either txt or html.

    You can find a list of all notification templates here

Go to admin panel

  • Scroll down and click on Save and continue editing and you should have the content of the template loaded automatically

Go to admin panel

  • Edit the Content field as you like and Save the changes.

Go to admin panel

Notifications

WALDUR_CORE.STRUCTURE

structure.change_email_request

A notification sent out when an email change is requested. Recipient is the old email address.

Templates

1
    Verify new email address.

1
    To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the {{ link }}.

1
    <p>To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the <a href="{{ link }}">link</a>.</p>

structure.notifications_profile_changes_operator

A notification sent out to notify about profile changes. The recipients are Waldur operators.

Templates

1
    Owner details have been updated

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
    Owner of
    {% for o in organizations %}
        {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
    {% endfor %}

    {{user.full_name}} (id={{ user.id }}) has changed

    {% for f in fields %}
        {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
    {% endfor %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
    Owner of
    {% for o in organizations %}
        {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
    {% endfor %}

    {{user.full_name}} (id={{ user.id }}) has changed

    {% for f in fields %}
        {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
    {% endfor %}

structure.structure_role_granted

A notification sent out when a role is granted. The recipient is the user who received the role.

Templates

1
    Role granted.

1
    Role {{ permission.role }}  for {{ structure }} has been granted.

1
    <p>Role {{ permission.role }}  for {{ structure }} has been granted.</p>

WALDUR_CORE.USERS

users.invitation_approved

A notification sent to notify the user that his invitation has been approved. The recipient is the user who's being invited.

Templates

1
    Account has been created

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    Hello!

    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
    Please visit the link below to sign up and accept your invitation:
    {{ link }}

    Your credentials are as following.

    Username is {{ username }}

    Your password is {{ password }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Account has been created</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
        Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
    </p>
    <p>
      Your credentials are as following.
    </p>
    <p>
      Your username is {{ username }}
    </p>
    <p>
      Your password is {{ password }}
    </p>
    </body>
    </html>

users.invitation_created

A notification sent to the user so that he can accept it and receive permissions. The recipient is the user who's being invited.

Templates

1
2
3
4
5
    {% if reminder %}
    REMINDER: Invitation to {{ name }} {{ type }}
    {% else %}
    Invitation to {{ name }} {{ type }}
    {% endif %}

1
2
3
4
5
6
    Hello!

    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
    Please visit the link below to sign up and accept your invitation:
    {{ link }}
    {{ extra_invitation_text }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation to {{ name }} {{ type }}</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
        Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
        Please note: this invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}!
    </p>
    <p>
        {{ extra_invitation_text }}
    </p>
    </body>
    </html>

users.invitation_expired

A notification sent out to notify the user that his invitation has expired. The recipient is the user who's being invited.

Templates

1
    Invitation has expired

1
2
3
4
    Hello!

    An invitation to {{ invitation.email }} has expired.
    This invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation to {{ invitation.email }} has expired</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        An invitation to {{ invitation.email }} has expired <br>
        An invitation to {{ invitation.email }} has expired at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

    </p>
    </body>
    </html>

users.invitation_rejected

A notification sent to notify the user that his invitation has been rejected. The recipient is the user who's being invited.

Templates

1
    Invitation has been rejected

1
2
3
4
5
6
7
8
9
    Hello!

    The following invitation has been rejected.

    Full name: {{ invitation.full_name }}

    Target: {{ name }} {{ type }}

    Role: {{ role }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Invitation to {{ name }} {{ type }}</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
      The following invitation has been rejected.
    </p>

    <p>
      Full name: {{ invitation.full_name }}
    </p>

    <p>
      Target: {{ name }} {{ type }}
    </p>

    <p>
      Role: {{ role }}
    </p>
    </body>
    </html>

users.invitation_requested

A notification sent to staff users so that they can approve or reject invitation. The recipients are active staff users.

Templates

1
    Invitation request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    Hello!

    {{ sender }} has created invitation request for the following user
    to join {{ name }} {{ type }} in {{ role }} role.

    {% if invitation.civil_number %}
    Civil number: {{ invitation.civil_number }}
    {% endif %}

    {% if invitation.phone_number %}
    Phone number: {{ invitation.phone_number }}
    {% endif %}

    E-mail: {{ invitation.email }}

    {% if invitation.full_name %}
    Full name: {{ invitation.full_name }}
    {% endif %}

    {% if invitation.native_name %}
    Native name: {{ invitation.native_name }}
    {% endif %}

    {% if invitation.organization %}
    Organization: {{ invitation.organization }}
    {% endif %}

    {% if invitation.job_title %}
    Job title: {{ invitation.job_title }}
    {% endif %}

    Please visit the link below to approve invitation: {{ approve_link }}

    Alternatively, you may reject invitation: {{ reject_link }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    <html>
    <head lang="en">
      <meta charset="UTF-8">
      <title>Invitation request</title>
    </head>
    <body>
    <p>
      Hello!
    </p>
    <p>
      {{ sender }} has created invitation request for the following user
      to join {{ name }} {{ type }} in {{ role }} role.
    </p>

    {% if invitation.civil_number %}
      <p>
        Civil number: {{ invitation.civil_number }}
      </p>
    {% endif %}

    {% if invitation.phone_number %}
      <p>
        Phone number: {{ invitation.phone_number }}
      </p>
    {% endif %}

    <p>
      E-mail: {{ invitation.email }}
    </p>

    {% if invitation.full_name %}
      <p>
        Full name: {{ invitation.full_name }}
      </p>
    {% endif %}

    {% if invitation.native_name %}
      <p>
        Native name: {{ invitation.native_name }}
      </p>
    {% endif %}

    {% if invitation.organization %}
      <p>
        Organization: {{ invitation.organization }}
      </p>
    {% endif %}

    {% if invitation.job_title %}
      <p>
        Job title: {{ invitation.job_title }}
      </p>
    {% endif %}

    <p>
      Please <a href="{{ approve_link }}">approve</a> or <a href="{{ reject_link }}">reject</a> invitation.
    </p>
    </body>
    </html>

users.permission_request_submitted

A notification sent out to notify about submitted permission request. The recipients are active staff users or customer owners.

Templates

1
    Permission request has been submitted.

1
2
3
4
5
    Hello!

    User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.

    Please visit the link below to approve or reject permission request: {{ requests_link }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    <html>
    <head lang="en">
      <meta charset="UTF-8">
      <title>Permission request has been submitted.</title>
    </head>
    <body>
    <p>
      Hello!
    </p>
    <p>
      User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.
    </p>
    <p>
      Please visit the <a href="{{ requests_link }}">link</a> to approve or reject permission request.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.BOOKING

booking.notification

A notification sent out to notify about upcoming bookings. The recipients are users who have upcoming bookings.

Templates

1
    Reminder about upcoming booking.

1
2
3
4
5
6
    Hello!

    Please do not forget about upcoming booking:
    {% for resource in resources %}
        {{ resource.name }}{% if not forloop.last %}, {% endif %}
    {% endfor %}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about upcoming booking.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Please do not forget about upcoming booking: <br />
        {% for resource in resources %}
            {{ resource.name }}
            {% if not forloop.last %}
                <br />
            {% endif %}
        {% endfor %}
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.INVOICES

invoices.notification

A notification of invoice. The recipients are organization owners.

Templates

1
    {{ customer }}'s invoice for {{ month }}/{{ year }}

1
2
3
4
    Hello,

    Please follow the link below to see {{ customer }}'s accounting information for {{ month }}/{{ year }}:
    {{ link }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html xmlns="http://www.w3.org/1999/html">
    <head lang="en">
        <meta charset="UTF-8">
        <title>{{ customer }}'s invoice for {{ month }}/{{ year }}</title>
    </head>
    <body>
    <p>
        Dear Sir or Madam,
    </p>
    <p>
        Attached is invoice for services consumed by {{ customer }}'s during {{ month }}/{{ year }}.
    </p>
    </body>
    </html>

invoices.upcoming_ends_notification

A notification about upcoming contract ending. The recipients are organization owners.

Templates

1
    {{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end

1
2
3
    Hello,

    this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>{{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end.</title>
    </head>
    <body>
    <p>
        Hello,
        <br/>
        this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.MARKETPLACE

marketplace.marketplace_resource_create_failed

A notification of a failed resource creation

Templates

1
    Resource {{ resource_name }} creation has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} creation has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} creation has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} creation has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_create_succeeded

A notification of a successful resource creation

Templates

1
    Resource {{ resource_name }} has been created.

1
2
3
    Hello!

    Resource {{ resource_name }} has been created.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} has been created.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} has been created.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_terminate_failed

A notification of a failed resource termination

Templates

1
    Resource {{ resource_name }} deletion has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} deletion has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} deletion has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} deletion has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_terminate_succeeded

A notification of a successful resource termination

Templates

1
    Resource {{ resource_name }} has been deleted.

1
2
3
    Hello!

    Resource {{ resource_name }} has been deleted.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} has been deleted.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} has been deleted.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_termination_scheduled

A notification of a scheduled resource termination. The recipients are project administrators and managers

Templates

1
    Resource {{ resource.name }} termination has been scheduled.

1
2
3
    Hello!

    The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource.name }} termination has been scheduled.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
        If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_termination_scheduled_staff

A notification of a resource termination. The recipients are project administrators and managers.

Templates

1
    Resource {{ resource.name }} termination has been scheduled.

1
2
3
    Hello!

    The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource.name }} termination has been scheduled.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
        If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_update_failed

A notification of failed resource update

Templates

1
    Resource {{ resource_name }} update has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} update has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} update has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} update has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_update_limits_failed

A notification of failed resource limits update

Templates

1
    Resource {{ resource_name }} limits update has failed.

1
2
3
    Hello!

    Resource {{ resource_name }} limits update has failed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} limits update has failed.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Resource {{ resource_name }} limits update has failed.
    </p>
    </body>
    </html>

marketplace.marketplace_resource_update_limits_succeeded

A notification of a successful resource limit update. The recipients are all the users in the project.

Templates

1
    Resource {{ resource_name }} limits have been updated.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    Hello!

    Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:
        {{ resource_old_limits }}
    to:
        {{ resource_limits }}.

    {% if support_email or support_phone %}
    If you have any additional questions, please contact support.
    {% if support_email %}
    Email: {{ support_email }}
    {% endif %}
    {% if support_phone %}
    Phone: {{ support_phone }}
    {% endif %}
    {% endif %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} limits have been updated.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:<br>
        <blockquote>
            {{ resource_old_limits }}
        </blockquote>
        to:
        <blockquote>
            {{ resource_limits }}
        </blockquote>
    </p>
    {% if support_email or support_phone %}
    <p>
        If you have any additional questions, please contact support.
    </p>
    {% if support_email %}
    <p>
        Email: {{ support_email }}
    </p>
    {% endif %}
    {% if support_phone %}
    <p>
        Phone: {{ support_phone }}
    </p>
    {% endif %}
    {% endif %}
    </body>
    </html>

marketplace.marketplace_resource_update_succeeded

A notification of a successful resource update. The recipients are all the users in the project.

Templates

1
    Resource {{ resource_name }} has been updated.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    Hello!

    Following request from {{ order_user }}, resource {{ resource_name }} has been updated.

    {% if resource_old_plan %}
    The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
    {% endif %}

    {% if support_email or support_phone %}
    If you have any additional questions, please contact support.
    {% if support_email %}
    Email: {{ support_email }}
    {% endif %}
    {% if support_phone %}
    Phone: {{ support_phone }}
    {% endif %}
    {% endif %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource_name }} has been updated.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Following request from {{ order_user }}, resource {{ resource_name }} has been updated.
    </p>
    {% if resource_old_plan %}
    <p>
        The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
    </p>
    {% endif %}
    {% if support_email or support_phone %}
    <p>
        If you have any additional questions, please contact support.
    </p>
    {% if support_email %}
    <p>
        Email: {{ support_email }}
    </p>
    {% endif %}
    {% if support_phone %}
    <p>
        Phone: {{ support_phone }}
    </p>
    {% endif %}
    {% endif %}
    </body>
    </html>

marketplace.notification_about_project_ending

A notification about project ending. The recipients are project managers and customer owners.

Templates

1
    {% if count_projects > 1 %}Your {{ count_projects }} projects{% else %} Project{% endif %} will be deleted on {{ end_date|date:'d/m/Y' }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    Hello {{ user.full_name }}!

    The following projects are ending {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}:

    {% for project in projects %}
        - {{ project.name }} ({{ project.url }})
    {% endfor %}

    End of the project will lead to termination of all resources in the project.
    If you are aware of that, then no actions are needed from your side.
    If you need to update project end date, please update it in project details.

    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Projects will be deleted.</title>
    </head>
    <body>
    <p>Hello {{ user.full_name }}!</p>
    <p>The following projects are ending {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}:</p>
    <ul>
    {% for project in projects %}
        <li><a href="{{ project.url }}">{{ project.name }}</a></li>
    {% endfor %}
    </ul>
    <p>
        End of the project will lead to termination of all resources in the project. <br />
        If you are aware of that, then no actions are needed from your side. <br />
        If you need to update project end date, please update it in project details.
    </p>
    <p>Thank you!</p>
    </body>
    </html>

marketplace.notification_about_resource_ending

A notification about resource ending. The recipients are project managers and customer owners.

Templates

1
    Resource {{ resource.name }} will be deleted.

1
2
3
4
5
6
7
    Dear {{ user.full_name }},

    Termination date of your {{ resource.name }} is approaching and it will be deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.
    If you are aware of that, then no actions are needed from your side.
    If you need to update resource end date, please update it in resource details {{ resource_url }}.

    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Resource {{ resource.name }} will be deleted.</title>
    </head>
    <body>
    <p>Dear {{ user.full_name }},</p>

    <p>
        Termination date of your {{ resource.name }} is approaching and it will be
        deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.<br />
        If you are aware of that, then no actions are needed from your side. <br />
        If you need to update resource end date, please update it in resource details {{ resource_url }}.
    </p>

    <p>Thank you!</p>
    </body>
    </html>

marketplace.notification_about_stale_resources

A notification about stale resources. The recipients are organization owners.

Templates

1
    Reminder about stale resources.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
    Hello!

    We noticed that you have stale resources that have not cost you anything for the last 3 months.
    Perhaps some of them are not needed any more?

    The resource names are:
    {% for resource in resources %}
        {{ resource.resource.name }} {{ resource.resource_url }}
    {% endfor %}
    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about stale resources.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        We noticed that you have stale resources that have not cost you anything for the last 3 months. <br />
        Perhaps some of them are not needed any more?<br />

        The resource names are:
        <ul>
            {% for resource in resources %}
                <li><a href='{{ resource.resource_url }}'>{{ resource.resource.name }}</a></li>
            {% endfor %}
        </ul>
        Thank you!
    </p>
    </body>
    </html>

marketplace.notification_to_user_that_order_been_rejected

Notification to user whose order been rejected.

Templates

1
    Your order to {{ order_type }} a resource {{ order.resource.name }} has been rejected.

1
2
3
    Hello!

    Your order {{ link }} to {{ order_type }} a resource {{ order.resource.name }} has been rejected.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Your order has been rejected.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Your <a href="{{ link }}">order</a> to {{ order_type }} a resource {{ order.resource.name }} has been rejected.
    </p>
    </body>
    </html>

marketplace.notification_usages

A notification about usages. The recipients are organization owners.

Templates

1
    Reminder about missing usage reports.

1
2
3
4
5
6
7
8
    Hello!

    Please do not forget to add usage for the resources you provide:
    {% regroup resources by offering as offering_list %}{% for offering in offering_list %}
    {{forloop.counter}}. {{ offering.grouper.name }}:{% for resource in offering.list %}
        - {{ resource.name }}
    {% endfor %}{% endfor %}
    You can submit resource usage via API or do it manually at {{ public_resources_url }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about missing usage reports.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>Please do not forget to add usage for the resources you provide:</p>
    {% regroup resources by offering as offering_list %}

    <ol>
    {% for offering in offering_list %}
        <li>
            {{ offering.grouper.name }}:
            <ul>
                {% for resource in offering.list %}
                <li>{{ resource.name }}</li>
                {% endfor %}
            </ul>
        </li>
    {% endfor %}
    </ol>

    <p>
        You can submit resource usage via API or do it <a href='{{ public_resources_url }}'>manually</a>.
    </p>
    </body>
    </html>

marketplace.notify_consumer_about_pending_order

A notification for consumer about pending order. The recipients are users that have permissions to approve the order.

Templates

1
    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

1
2
3
    Hello!

    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Please visit <a href="{{ order_link }}">{{ site_name }}</a> to find out more details.
    </p>
    </body>
    </html>

marketplace.notify_provider_about_pending_order

A notification for provider about pending order. The recipients are users that have permissions to approve the order.

Templates

1
    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

1
2
3
    Hello!

    A new order by {{ order.created_by.get_full_name }} is waiting for approval.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        Please visit <a href="{{ order_url }}">{{ site_name }}</a> to find out more details.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.MARKETPLACE_REMOTE

marketplace_remote.notification_about_pending_project_updates

A notification about pending project updates. The recipients are customer owners

Templates

1
    Reminder about pending project updates.

1
2
3
4
5
6
7
8
    Hello!

    We noticed that you have pending project update requests.
    Perhaps you would like to have a look at them?

    The project is:
        {{ project_update_request.project.name }} {{ project_url }}
    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>Reminder about pending project updates.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        We noticed that you have pending project update requests.<br />
        Perhaps you would like to have a look at them?<br />

        The project is:
        <ul>
            <li><a href='{{ project_url }}'>{{ project_update_request.project.name }}</a></li>
        </ul>
        Thank you!
    </p>
    </body>
    </html>

marketplace_remote.notification_about_project_details_update

A notification about project details update. The recipients the user who requested project details update and the user that reviewed it.

Templates

1
    A notification about project details update.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
    Hello!

    We would like to notify you about recent updates in project details.
    Perhaps you would like to have a look at them?

    The project is:
        {{ new_name }} {{ project_url }}

        Details after the update are below:
            {% if new_description %}
                Old description: {{ old_description }}
                New description: {{ new_description }}
            {% endif %}

            {% if new_name %}
                Old name: {{ old_name }}
                New name: {{ new_name }}
            {% endif %}

            {% if new_end_date %}
               Old end date: {{ old_end_date }}
               New end date: {{ new_end_date }}
            {% endif %}

            {% if new_oecd_fos_2007_code %}
               Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}
               New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}
            {% endif %}

            {% if new_is_industry %}
               Old is_industry: {{ old_is_industry }}
               New is_industry: {{ new_is_industry }}
            {% endif %}

        Reviewed by: {{ reviewed_by }}
    Thank you!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>A notification about project details update.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        We would like to notify you about recent updates in project details.<br />
        Perhaps you would like to have a look at them?<br />

        The project is:
        <ul>
            <li><a href='{{ project_url }}'>{{ new_name }}</a></li>
        </ul>

        <div>
            Details after the update are below:
            <ul>
                {% if new_description %}
                    <li>Old description: {{ old_description }}</li>
                    <li>New description: {{ new_description }}</li>
                {% endif %}

                {% if new_name %}
                    <li>Old name: {{ old_name }}</li>
                    <li>New name: {{ new_name }}</li>
                {% endif %}

                {% if new_end_date %}
                    <li>Old end date: {{ old_end_date }}</li>
                    <li>New end date: {{ new_end_date }}</li>
                {% endif %}

                {% if new_oecd_fos_2007_code %}
                    <li>Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}</li>
                    <li>New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}</li>
                {% endif %}

                {% if new_is_industry %}
                    <li>Old is_industry: {{ old_is_industry }}</li>
                    <li>New is_industry: {{ new_is_industry }}</li>
                {% endif %}
                <li>Reviewed by: {{ reviewed_by }}</li>
            </ul>

        </div>
        Thank you!
    </p>
    </body>
    </html>

marketplace_policy.notification_about_project_cost_exceeded_limit

Notification about project cost exceeded limit. The recipients are all customer owners of the project.

Templates

1
    {{ scope_class }} {{ scope_name }} cost has exceeded the limit.

1
2
    Hello!
    {{ scope_class }} {{ scope_name }} ({{ scope_url }}) cost has exceeded the limit of {{ limit }}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>{{ scope_class }} {{ scope_name }} cost has exceeded the limit.</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    <p>
        {{ scope_class }} <a href='{{ scope_url }}'>{{ scope_name }}</a> cost has exceeded the limit of {{ limit }}.
    </p>
    </body>
    </html>

WALDUR_MASTERMIND.SUPPORT

support.description

A notification used for issue creation.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    {{issue.description}}

    Additional Info:
    {% if issue.customer %}- Organization: {{issue.customer.name}}{% endif %}
    {% if issue.project %}- Project: {{issue.project.name}}{% endif %}
    {% if issue.resource %}
        {% if issue.resource.service_settings %}
            {% if issue.resource.service_settings.type %}- Service type: {{issue.resource.service_settings.type}}{% endif %}
            - Offering name: {{ issue.resource.service_settings.name }}
            - Offering provided by: {{ issue.resource.service_settings.customer.name }}
        {% endif %}
        - Affected resource: {{issue.resource}}
        - Backend ID: {{issue.resource.backend_id}}
    {% endif %}
    - Site name: {{ settings.WALDUR_CORE.SITE_NAME }}
    - Site URL: {{ config.HOMEPORT_URL }}

support.notification_comment_added

Notification about a new comment in the issue. The recipient is issue caller.

Templates

1
2
3
    Hello!

    The issue you have created has a new comment. Please go to {{issue_url}} to see it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The issue you have created ({{ issue.key }}) has a new comment</title>
    </head>
    <body>
    <p>
        {% if is_system_comment %}
            Added a new comment.
        {% else %}
            {{ comment.author.name }} added a new comment.
        {% endif %}
    </p>
    <p>
        <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
    </p>
    <div>
        {{ description|safe }}
    </div>
    </body>
    </html>

1
    The issue ({{ issue.key }}) you have created has a new comment

support.notification_comment_updated

Notification about an update in the issue comment. The recipient is issue caller.

Templates

1
2
3
    Hello!

    The comment has been updated. Please go to {{issue_url}} to see it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The comment has been updated ({{ issue.key }})</title>
    </head>
    <body>
    <p>
        {{ comment.author.name }} updated comment.
    </p>
    <p>
        <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
    </p>
    <p>
        Old comment:
    </p>
    <p>
        {{ old_description|safe }}
    </p>
    <p>
        New comment:
    </p>
    <p>
        {{ description|safe }}
    </p>
    </body>
    </html>

1
    Issue {{ issue.key }}. The comment has been updated

support.notification_issue_feedback

Notification about a feedback related to the issue. The recipient is issue caller.

Templates

1
2
3
4
5
6
7
8
9
    Hello, {{issue.caller.full_name}}!

    We would like to hear your feedback regarding your recent experience with support for {{issue_url}}.

    Click on the evaluations below to provide the feedback.

    {% for link in feedback_links%}
        {{link.label}}: {{link.link}}
    {% endfor %}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The issue you have ({{ issue.key }}) has been updated</title>

        <style>
            * {
              font-family: sans-serif;
            }
            .rating {
              unicode-bidi: bidi-override;
              direction: rtl;
              width: 500px;
            }
            .rating > a {
              display: inline-block;
              position: relative;
              width: 1.1em;
              text-decoration: none;
              font-size: xx-large;
              color: rgba(180, 179, 178, 1);
            }
            .rating > a:hover:before,
            .rating > a:hover ~ a:before {
               content: "\2605";
               position: absolute;
               color: rgba(224, 194, 75, 1);
            }
        </style>

    </head>
    <body>
    <p>Hello, {{issue.caller.full_name}}!</p>
    <p>We would like to hear your feedback regarding your recent experience with support for
        <a href='{{issue_url}}'>{{ issue.summary }}</a>.
    </p>
    <p>Click the stars below to provide your feedback:</p>
    <div class="rating">
        {% for link in feedback_links reversed %}
            <a href='{{link.link}}'>☆</a>
        {% endfor %}
    </div>
    </body>
    </html>

1
    Please share your feedback: {{issue.key}} {{issue.summary}}

support.notification_issue_updated

Notification about an update in the issue. The recipient is issue caller.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    Hello!

    The issue you have has been updated.

    {% if changed.status %}
    Status has been changed from {{ changed.status }} to {{ issue.status }}.
    {% endif %}
    {% if changed.description %}
    Description has been changed from {{ changed.description }} to {{ issue.description }}.
    {% endif %}
    {% if changed.summary %}
    Summary has been changed from {{ changed.summary }} to {{ issue.summary }}.
    {% endif %}
    {% if changed.priority %}
    Priority has been changed from {{ changed.priority }} to {{ issue.priority }}.
    {% endif %}

    Please go to {{issue_url}} to see it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>The issue you have ({{ issue.key }}) has been updated</title>
    </head>
    <body>
    <p>
        Hello!
    </p>
    {% if changed.status %}
    <p>
        Status has been changed from <strong>{{ changed.status }}</strong> to <strong>{{ issue.status }}</strong>.
    </p>
    {% endif %}
    {% if old_description %}
    <p>
        Description has been changed from <strong>{{ old_description|safe }}</strong> to <strong>{{ description|safe }}</strong>.
    </p>
    {% endif %}
    {% if changed.summary %}
    <p>
        Summary has been changed from <strong>{{ changed.summary }}</strong> to <strong>{{ issue.summary }}</strong>.
    </p>
    {% endif %}
    {% if changed.priority %}
    <p>
        Priority has been changed from <strong>{{ changed.priority }}</strong> to <strong>{{ issue.priority }}</strong>.
    </p>
    {% endif %}
    <p>
        Please visit <a href="{{ issue_url }}">{{ site_name }}</a> to find out more details.
    </p>
    </body>
    </html>

1
    Updated issue: {{issue.key}} {{issue.summary}}

support.summary

A notification used for issue creation.

Templates

1
    {% if issue.customer.abbreviation %}{{issue.customer.abbreviation}}: {% endif %}{{issue.summary}}

WALDUR_MASTERMIND.PROPOSAL

proposal.new_proposal_submitted

A notification to the call manager about a new proposal submission.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    Dear call manager,

    A new proposal has been submitted to the call "{{ call_name }}".

    Proposal details:
    - Name: {{ proposal_name }}
    - Submitted by: {{ proposal_creator_name }}
    - Submission date: {{ submission_date }}
    - Round: {{ round_name }}

    You can review this proposal by visiting the following URL:
    {{ proposal_url }}

    This is an automated message from the {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
    <html>
    <head>
        <meta charset="UTF-8">
    </head>
    <body>
        <p>Dear call manager,</p>

        <p>A new proposal has been submitted to the call "{{ call_name }}".</p>

        <p>
            <strong>Proposal details:</strong><br>
            - Name: {{ proposal_name }}<br>
            - Submitted by: {{ proposal_creator_name }}<br>
            - Submission date: {{ submission_date }}<br>
            - Round: {{ round_name }}
        </p>

        <p>
            You can review this proposal by visiting the following URL:<br>
            <a href="{{ proposal_url }}">{{ proposal_url }}</a>
        </p>

        <p>
            This is an automated message from the {{ site_name }}. Please do not reply to this email.
        </p>
    </body>
    </html>

1
    New proposal submitted: {{ proposal_name }}

proposal.new_review_submitted

A notification to the call manager about a new review submission.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    Dear call manager,

    A review has been submitted for proposal "{{ proposal_name }}" in call "{{ call_name }}".

    Review summary:
    - Reviewer: {{ reviewer_name }}
    - Submission date: {{ submission_date }}
    - Score: {{ score }}/{{ max_score }}

    Review Progress:
    - Submitted reviews: {{ submitted_reviews }}
    - Pending reviews: {{ pending_reviews }}
    - Rejected reviews: {{ rejected_reviews }}

    You can view the full review details at:
    {{ review_url }}

    This is an automated message from the {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Review Submitted</title>
    </head>
    <body>
        <p>Dear call manager,</p>

        <p>A review has been submitted for proposal "{{ proposal_name }}" in call "{{ call_name }}".</p>

        <p>
            <strong>Review summary:</strong><br>
            - Reviewer: {{ reviewer_name }}<br>
            - Submission date: {{ review_date }}<br>
            - Score: {{ score }}/{{ max_score }}
        </p>

        <p>
            <strong>Review Progress:</strong><br>
            - Submitted reviews: {{ submitted_reviews }}<br>
            - Pending reviews: {{ pending_reviews }}<br>
            - Rejected reviews: {{ rejected_reviews }}<br>
        </p>

        <p>
            You can view the full review details at:<br>
            <a href="{{ review_url }}">{{ review_url }}</a>
        </p>

        <p>
            This is an automated message from the {{ site_name }}. Please do not reply to this email.
        </p>
    </body>
    </html>

1
    Review submitted for proposal: {{ proposal_name }}

proposal.proposal_cancelled

A notification to proposal creator about the proposal cancellation.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    Dear {{ proposal_creator_name }},

    Your proposal "{{ proposal_name }}" in call "{{ call_name }}" has been canceled.

    Cancellation details:
    - Proposal: {{ proposal_name }}
    - Cancellation date: {{ cancellation_date }}
    - Reason for cancellation: Round closure/The submission deadline has passed and the proposal was not finalized

    All draft proposals are automatically canceled when a round closes. This ensures that only fully submitted proposals proceed to the review stage.

    You can still view your proposal by visiting:
    {{ proposal_url }}

    If you would like to resubmit your proposal, please check for upcoming rounds in this call or other relevant calls.

    This is an automated message from the {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Proposal Canceled</title>
    </head>
    <body>
        <p>Dear {{ proposal_creator_name }},</p>

        <p>Your proposal "{{ proposal_name }}" in call "{{ call_name }}" has been canceled.</p>

        <p>
            <strong>Cancellation details:</strong><br>
            - Proposal: {{ proposal_name }}<br>
            - Cancelation date: {{ cancellation_date }}<br>
            - Reason for cancellation: Round closure/The submission deadline has passed and the proposal was not finalized
        </p>

        <p>All draft proposals are automatically canceled when a round closes. This ensures that only fully submitted proposals proceed to the review stage.</p>

        <p>
            You can still view your proposal by visiting:<br>
            <a href="{{ proposal_url }}">{{ proposal_url }}</a>
        </p>

        <p>If you would like to resubmit your proposal, please check for upcoming rounds in this call or other relevant calls.</p>

        <p>
            This is an automated message from the {{ site_name }}. Please do not reply to this email.
        </p>
    </body>
    </html>

1
    Proposal canceled: {{ proposal_name }}

proposal.proposal_decision_for_reviewer

A notification to the reviewer about the proposal decision (approved/rejected) which they reviewed.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    Dear {{ reviewer_name }},

    A decision has been made on the proposal "{{ proposal_name }}" in call "{{ call_name }}" that you reviewed.

    Decision details:
    - Proposal: {{ proposal_name }}
    - Decision: {{ proposal_state }}
    - Decision date: {{ decision_date }}

    {% if proposal_state == "rejected" and rejection_reason %}Reason: {{ rejection_reason }}{% endif %}

    Thank you for your valuable contribution to the review process. Your expert assessment helped inform this decision.

    View proposal: {{ proposal_url }}

    This is an automated message from {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Proposal {{ proposal_state }}</title>
    </head>
    <body>
        <p>Dear {{ reviewer_name }},</p>

        <p>A decision has been made on the proposal "<strong>{{ proposal_name }}</strong>" in call "<strong>{{ call_name }}</strong>" that you reviewed.</p>

        <p><strong>Decision details:</strong></p>
        <ul>
            <li><strong>Proposal:</strong> {{ proposal_name }}</li>
            <li><strong>Decision:</strong> {{ proposal_state }}</li>
            <li><strong>Decision date:</strong> {{ decision_date }}</li>
        </ul>

        {% if proposal_state == "rejected" and rejection_reason %}
        <p><strong>Reason:</strong> {{ rejection_reason }}</p>
        {% endif %}

        <p>Thank you for your valuable contribution to the review process. Your expert assessment helped inform this decision.</p>

        <p>View proposal: <a href="{{ proposal_url }}">{{ proposal_url }}</a></p>

        <p><em>This is an automated message from {{ site_name }}. Please do not reply to this email.</em></p>
    </body>
    </html>

1
    Decision made: Proposal {{ proposal_state }} - {{ proposal_name }}

proposal.proposal_state_changed

A notification about the proposal state changes (submitted → in review → accepted/rejected).

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    Dear {{ proposal_creator_name }},

    The state of your proposal "{{ proposal_name }}" in call "{{ call_name }}" has been updated.

    State change:
    - Previous state: {{ previous_state }}
    - New state: {{ new_state }}
    - Updated on: {{ update_date }}

    {% if new_state == 'accepted' %}
    Project created: {{ project_name }}
    Allocation start date: {{ allocation_date }}
    Duration: {{ duration }} days

    Allocated resources:
    {% for resource in allocated_resources %}
    {{ forloop.counter }}. {{ resource.name }} - {{ resource.provider_name }} - {{ resource.plan_name }} - Provisioned
    {% empty %}
    No resources allocated yet.
    {% endfor %}
    {% endif %}

    {% if new_state == 'rejected' %}
    Feedback: {{ rejection_feedback }}
    {% endif %}

    {% if new_state == 'submitted' %}
    Your proposal has been successfully submitted and will be reviewed according to the review process for this call. You will receive further notifications as your proposal progresses through the review process.
    {% endif %}

    {% if new_state == 'in_review' %}
    Your proposal is now under review. Reviewers will evaluate your proposal based on the criteria specified in the call. This process may take {{ review_period }} days according to the round's review period.
    {% endif %}

    {% if new_state == 'accepted' %}
    Congratulations! Your proposal has been accepted. Resources have been allocated based on your request and a new project has been created. You can access your project by clicking the link below.
    {% endif %}

    {% if new_state == 'rejected' %}
    We regret to inform you that your proposal has not been accepted at this time. Please review any feedback provided above. You may have the opportunity to submit a revised proposal in future rounds.
    {% endif %}

    View Proposal: {{ proposal_url }}
    {% if new_state == 'accepted' and project_url %}
    View Project: {{ project_url }}
    {% endif %}

    This is an automated message from the {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Proposal Status Update</title>
        <style>
            body {
                color: #333;
                max-width: 600px;
                margin: 0 auto;
                padding: 20px;
            }
            .header {
                margin-bottom: 20px;
            }
            .state-change {
                background-color: #f9f9f9;
                padding: 15px;
                border-radius: 5px;
                margin-bottom: 20px;
            }
            .message-box {
                padding: 15px;
                margin: 15px 0;
            }
            .footer {
                margin-top: 30px;
                color: #777;
                border-top: 1px solid #eee;
                padding-top: 10px;
            }
        </style>
    </head>
    <body>
        <div class="header">
            <p>Dear {{ proposal_creator_name }},</p>
            <p>The state of your proposal "<strong>{{ proposal_name }}</strong>" in call "<strong>{{ call_name }}</strong>" has been updated.</p>
        </div>

        <div class="state-change">
            <h3>State change:</h3>
            <ul>
                <li><strong>Previous state:</strong> {{ previous_state }}</li>
                <li><strong>New state:</strong> {{ new_state }}</li>
                <li><strong>Updated on:</strong> {{ update_date }}</li>
            </ul>

            {% if new_state == 'accepted' %}
            <ul>
                <li><strong>Project created:</strong> {{ project_name }}</li>
                <li><strong>Allocation start date:</strong> {{ allocation_date }}</li>
                <li><strong>Duration:</strong> {{ duration }} days</li>
            </ul>
            <div>
                <h4>Allocated resources:</h4>
                {% for resource in allocated_resources %}
                <div>
                    <strong>{{ forloop.counter }}.</strong> {{ resource.name }} - {{ resource.provider_name }} - {{ resource.plan_name }} - Provisioned
                </div>
                {% empty %}
                <p><em>No resources allocated yet.</em></p>
                {% endfor %}
            </div>
            {% endif %}

            {% if new_state == 'rejected' %}
            <p><strong>Feedback:</strong> {{ rejection_feedback }}</p>
            {% endif %}
        </div>

        <div class="message-box">
            {% if new_state == 'submitted' %}
            <p>Your proposal has been successfully submitted and will be reviewed according to the review process for this call. You will receive further notifications as your proposal progresses through the review process.</p>
            {% endif %}

            {% if new_state == 'in_review' %}
            <p>Your proposal is now under review. Reviewers will evaluate your proposal based on the criteria specified in the call. This process may take {{ review_period }} days according to the round's review period.</p>
            {% endif %}

            {% if new_state == 'accepted' %}
            <p>Congratulations! Your proposal has been accepted. Resources have been allocated based on your request and a new project has been created. You can access your project by clicking the link below.</p>
            {% endif %}

            {% if new_state == 'rejected' %}
            <p>We regret to inform you that your proposal has not been accepted at this time. Please review any feedback provided above. You may have the opportunity to submit a revised proposal in future rounds.</p>
            {% endif %}
        </div>

        <a href="{{ proposal_url }}">View Proposal</a>
        <br>
        {% if new_state == 'accepted' and project_url %}
        <a href="{{ project_url }}">View Project</a>
        {% endif %}

        <div class="footer">
            <p>This is an automated message from the {{ site_name }}. Please do not reply to this email.</p>
        </div>
    </body>
    </html>

1
    Proposal state update: {{ proposal_name }} - {{ new_state }}

proposal.requested_offering_decision

A notification to call manager about the decision on requested offering (accepted/rejected).

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    Dear call manager,

    The provider has {{ decision }} the request to include offering "{{ offering_name }}" in call "{{ call_name }}".

    Offering details:
    - Offering: {{ offering_name }}
    - Provider: {{ provider_name }}
    - Decision Date: {{ decision_date }}
    - State: {{ decision }}

    {% if decision == "accepted" %}This offering is now available for selection in proposals submitted to this call.{% endif %}

    {% if decision == "canceled" %}You may need to look for alternative offerings or contact the provider directly for more information about their decision.{% endif %}

    You can view the call details and manage offerings by visiting:
    {{ call_url }}

    This is an automated message from {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Offering request {{ decision }}</title>
    </head>
    <body>
        <p>Dear call manager,</p>

        <p>The provider has <strong>{{ decision }}</strong> the request to include offering "<strong>{{ offering_name }}</strong>" in call "<strong>{{ call_name }}</strong>".</p>

        <p><strong>Offering details:</strong></p>
        <ul>
            <li><strong>Offering:</strong> {{ offering_name }}</li>
            <li><strong>Provider:</strong> {{ provider_name }}</li>
            <li><strong>Decision Date:</strong> {{ decision_date }}</li>
            <li><strong>State:</strong> {{ decision }}</li>
        </ul>

        {% if decision == "accepted" %}
        <p>This offering is now available for selection in proposals submitted to this call.</p>
        {% endif %}

        {% if decision == "canceled" %}
        <p>You may need to look for alternative offerings or contact the provider directly for more information about their decision.</p>
        {% endif %}

        <p>You can view the call details and manage offerings by visiting:<br>
        <a href="{{ call_url }}">{{ call_url }}</a></p>

        <p><em>This is an automated message from {{ site_name }}. Please do not reply to this email.</em></p>
    </body>
    </html>

1
    Offering request {{ decision }}: {{ offering_name }}

proposal.review_assigned

A notification to a reviewer about a new review assignment.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    Dear {{ reviewer_name }},

    You have been assigned to review a proposal in call "{{ call_name }}".

    Proposal details:
    - Proposal name: {{ proposal_name }}
    - Submitted by: {{ proposal_creator_name }}
    - Date submitted: {{ submission_date }}
    - Review deadline: {{ review_deadline }}

    Please log in to the platform to review the proposal. You can accept or reject this review assignment by visiting:

    {{ link_to_reviews_list }}

    If you accept this assignment, you'll be able to access the full proposal content and submit your review.

    This is an automated message from {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <html>
    <head>
        <meta charset="UTF-8">
    </head>
    <body>
    <p>Dear {{ reviewer_name }},</p>

    <p>You have been assigned to review a proposal in call "<strong>{{ call_name }}</strong>".</p>

    <p><strong>Proposal details:</strong></p>
    <ul>
        <li><strong>Proposal name:</strong> {{ proposal_name }}</li>
        <li><strong>Submitted by:</strong> {{ proposal_creator_name }}</li>
        <li><strong>Date submitted:</strong> {{ submission_date }}</li>
        <li><strong>Review deadline:</strong> {{ review_deadline }}</li>
    </ul>

    <p>Please log in to the platform to review the proposal. You can accept or reject this review assignment by visiting:</p>

    <a href="{{ link_to_reviews_list }}">{{ link_to_reviews_list }}</a>

    <p>If you accept this assignment, you'll be able to access the full proposal content and submit your review.</p>

    <p><em>This is an automated message from {{ site_name }}. Please do not reply to this email.</em></p>
    </body>
    </html>

1
    New review assignment: {{ proposal_name }}

proposal.review_rejected

A notification to the call managers about a rejected review.

Templates

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
    Dear call manager,

    A reviewer has rejected their assignment to review proposal "{{ proposal_name }}" in call "{{ call_name }}".

    Assignment details:
    - Reviewer: {{ reviewer_name }}
    - Assigned date: {{ assign_date }}
    - Rejected date: {{ rejection_date }}

    ACTION REQUIRED: Please assign a new reviewer to maintain the minimum required number of reviews for this proposal.

    Review Progress:
    - Submitted reviews: {{ submitted_reviews }}
    - Pending reviews: {{ pending_reviews }}
    - Rejected reviews: {{ rejected_reviews }}

    You can assign a new reviewer by visiting:
    {{ create_review_link }}

    This is an automated message from the {{ site_name }}. Please do not reply to this email.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    <html>
    <head>
        <meta charset="UTF-8">
        <title>Reviewer Assignment Rejected</title>
    </head>
    <body>
        <p>Dear call manager,</p>

        <p>A reviewer has rejected their assignment to review proposal "{{ proposal_name }}" in call "{{ call_name }}".</p>

        <p>
            <strong>Assignment details:</strong><br>
            - Reviewer: {{ reviewer_name }}<br>
            - Assigned date: {{ assign_date }}<br>
            - Rejected date: {{ rejection_date }}
        </p>

        <p>
            <strong style="color: #d9534f;">ACTION REQUIRED:</strong> Please assign a new reviewer to maintain the minimum required number of reviews for this proposal.
        </p>

        <p>
            <strong>Review Progress:</strong><br>
            - Submitted reviews: {{ submitted_reviews }}<br>
            - Pending reviews: {{ pending_reviews }}<br>
            - Rejected reviews: {{ rejected_reviews }}<br>
        </p>

        <p>
            You can assign a new reviewer by visiting:<br>
            <a href="{{ create_review_link }}">{{ create_review_link }}</a>
        </p>

        <p>
            This is an automated message from the {{ site_name }}. Please do not reply to this email.
        </p>
    </body>
    </html>

1
    Alert: review assignment rejected for {{ proposal_name }}

Scheduled Background Jobs

This document lists all scheduled background jobs (Celery beat tasks) configured in the system.

Job Name Task Schedule Description
cancel-expired-invitations waldur_core.users.cancel_expired_invitations 1 day Invitation lifetime must be specified in Waldur Core settings with parameter
"INVITATION_LIFETIME". If invitation creation time is less than expiration time, the invitation will set as expired.
cancel_expired_group_invitations waldur_core.users.cancel_expired_group_invitations 1 day Invitation lifetime must be specified in Waldur Core settings with parameter
"GROUP_INVITATION_LIFETIME". If invitation creation time is less than expiration time,
the invitation will set as expired.
check-expired-permissions waldur_core.permissions.check_expired_permissions 1 day Task not found in registry
check-polices waldur_mastermind.policy.check_polices Cron: * * 1 * * (m/h/dM/MY/d) Evaluate all policies across all policy types in the system.
cleanup-orphaned-answers waldur_core.checklist.cleanup_orphaned_answers 1 day Task not found in registry
core-reset-updating-resources waldur_core.reset_updating_resources 10 minutes Reset resources stuck in UPDATING state when their Celery tasks are completed.
create-reviews-if-strategy-is-after-proposal waldur_mastermind.proposal.create_reviews_if_strategy_is_after_proposal 1 hour Create reviews for active rounds with 'after proposal' review strategy.
create-reviews-if-strategy-is-after-round waldur_mastermind.proposal.create_reviews_if_strategy_is_after_round 1 hour Create reviews for active rounds with 'after round' review strategy.
create_customer_permission_reviews waldur_core.structure.create_customer_permission_reviews 1 day Create customer permission reviews for customers that need periodic review of user permissions.
expired-reviews-should-be-cancelled waldur_mastermind.proposal.expired_reviews_should_be_cancelled 1 hour Cancel reviews that have expired.
mark-offering-backend-as-disconnected-after-timeout waldur_mastermind.marketplace_site_agent.mark_offering_backend_as_disconnected_after_timeout 1 hour No description available
mark_resources_as_erred_after_timeout waldur_mastermind.marketplace.mark_resources_as_erred_after_timeout 2 hours Mark stale orders and their resources as erred if they have been executing for more than 2 hours.
marketplace-openstack.create-resources-for-lost-instances-and-volumes waldur_mastermind.marketplace_openstack.create_resources_for_lost_instances_and_volumes 6 hours Create marketplace resources for OpenStack instances and volumes that exist in backend but are missing from marketplace.
marketplace-openstack.refresh-instance-backend-metadata waldur_mastermind.marketplace_openstack.refresh_instance_backend_metadata 1 day Refresh metadata for OpenStack instances from backend to ensure marketplace resources have up-to-date information.
notification_about_project_ending waldur_mastermind.marketplace.notification_about_project_ending Cron: 0 10 * * * (m/h/dM/MY/d) Send notifications about projects ending in 1 day and 7 days.
notification_about_resource_ending waldur_mastermind.marketplace.notification_about_resource_ending Cron: 0 10 * * * (m/h/dM/MY/d) Send notifications about resources ending in 1 day and 7 days.
notify_about_stale_resource waldur_mastermind.marketplace.notify_about_stale_resource Cron: 0 15 5 * * (m/h/dM/MY/d) Notify customers about resources that have not generated invoice items in the last 3 months.
openstack-delete-expired-backups openstack.DeleteExpiredBackups 10 minutes Delete expired OpenStack backup resources that have reached their retention period.
openstack-delete-expired-snapshots openstack.DeleteExpiredSnapshots 10 minutes Delete expired OpenStack snapshot resources that have reached their retention period.
openstack-tenant-properties-list-pull-task openstack.tenant_properties_list_pull_task 1 day Pull OpenStack tenant properties like flavors, images, and volume types from backend.
openstack-tenant-pull-quotas openstack.TenantPullQuotas 12 hours Pull quota limits and usage information for all OpenStack tenants.
openstack-tenant-resources-list-pull-task openstack.tenant_resources_list_pull_task 1 hour Pull OpenStack tenant resources like instances, volumes, and snapshots from backend.
openstack-tenant-subresources-list-pull-task openstack.tenant_subresources_list_pull_task 2 hours Pull OpenStack tenant subresources like security groups, networks, subnets, and ports from backend.
openstack_mark_as_erred_old_tenants_in_deleting_state openstack.mark_as_erred_old_tenants_in_deleting_state 1 day Mark OpenStack tenants as erred if they have been in deleting state for more than 1 day.
openstack_mark_stuck_updating_tenants_as_erred openstack.mark_stuck_updating_tenants_as_erred 1 hour No description available
process-pending-project-invitations waldur_core.users.process_pending_project_invitations 2 hours Process project invitations for projects that have become active.
process_pending_project_orders waldur_mastermind.marketplace.process_pending_project_orders 2 hours Process orders for projects that have become active.
proposals-for-ended-rounds-should-be-cancelled waldur_mastermind.proposal.proposals_for_ended_rounds_should_be_cancelled 1 hour Cancel proposals for rounds that have ended.
pull-priorities waldur_mastermind.support.pull_priorities 1 day Pull priority levels from the active support backend.
pull-service-properties waldur_core.structure.ServicePropertiesListPullTask 1 day Pull service properties from all active service backends.
pull-service-resources waldur_core.structure.ServiceResourcesListPullTask Hourly (at minute 0) Pull resources from all active service backends.
pull-support-users waldur_mastermind.support.pull_support_users 6 hours Pull support users from the active support backend.
remove_deleted_robot_accounts waldur_mastermind.marketplace.remove_deleted_robot_accounts 1 day Remove robot accounts that are in DELETED state.
This task runs daily to clean up robot accounts that have been marked for deletion.
restrict_offering_users_for_revoked_consents waldur_mastermind.marketplace.restrict_offering_users_for_revoked_consents 1 day Task not found in registry
send-messages-about-pending-orders waldur_mastermind.marketplace_site_agent.send_messages_about_pending_orders 1 hour Send a message about pending orders created 1 hour ago to MQTT
send-monthly-invoicing-reports-about-customers invoices.send_monthly_invoicing_reports_about_customers Cron: 0 0 2 * * (m/h/dM/MY/d) Send monthly invoicing reports via email to configured recipients.
send-notifications-about-upcoming-ends invoices.send_notifications_about_upcoming_ends 1 day Send notifications about upcoming end dates of fixed payment profiles.
send-reminder-for-pending-invitations waldur_core.users.send_reminder_for_pending_invitations 1 day Send reminder emails for pending invitations that are about to expire.
send-scheduled-broadcast-notifications waldur_mastermind.notifications.send_scheduled_broadcast_messages 12 hours Send broadcast messages that have been scheduled for delivery.
send_telemetry waldur_mastermind.marketplace.send_metrics 1 day Send anonymous usage metrics and telemetry data to the Waldur team.
structure-set-erred-stuck-resources waldur_core.structure.SetErredStuckResources 1 hour This task marks all resources which have been provisioning for more than 3 hours as erred.
sync-resources waldur_mastermind.marketplace_site_agent.sync_resources 10 minutes Sync resources that haven't been updated in the last hour.
Processes only resources that users have subscribed to receive updates for.
sync_request_types waldur_mastermind.support.sync_request_types 1 day Synchronize request types from the active support backend.
terminate_expired_resources waldur_mastermind.marketplace.terminate_expired_resources Cron: 20 1 * * * (m/h/dM/MY/d) Terminate marketplace resources that have reached their end date.
terminate_resources_if_project_end_date_has_been_reached waldur_mastermind.marketplace.terminate_resources_if_project_end_date_has_been_reached Cron: 40 1 * * * (m/h/dM/MY/d) Terminate resources when their project has reached its end date.
terminate_resources_in_state_erred_without_backend_id_and_failed_terminate_order waldur_mastermind.marketplace.terminate_resources_in_state_erred_without_backend_id_and_failed_terminate_order 1 day Clean up erred Slurm resources that failed both creation and termination.
update-custom-quotas waldur_core.quotas.update_custom_quotas 1 hour Task not found in registry
update-invoices-total-cost invoices.update_invoices_total_cost 1 day Update cached total cost for current month invoices.
update-standard-quotas waldur_core.quotas.update_standard_quotas 1 day Task not found in registry
valimo-auth-cleanup-auth-results waldur_auth_valimo.cleanup_auth_results 1 hour Clean up Valimo authentication results older than 7 days.
waldur-create-invoices invoices.create_monthly_invoices Monthly (1st day of month at midnight) - For every customer change state of the invoices for previous months from "pending" to "billed"
and freeze their items.
- Create new invoice for every customer in current month if not created yet.
waldur-create-offering-users-for-site-agent-offerings waldur_mastermind.marketplace_site_agent.sync_offering_users 1 day No description available
waldur-firecrest-pull-jobs waldur_firecrest.pull_jobs 1 hour Pull SLURM jobs from Firecrest API for all offering users with valid OAuth tokens.
waldur-freeipa-sync-groups waldur_freeipa.sync_groups 10 minutes This task is used by Celery beat in order to periodically
schedule FreeIPA group synchronization.
waldur-freeipa-sync-names waldur_freeipa.sync_names 1 day Synchronize user names between Waldur and FreeIPA backend.
waldur-marketplace-calculate-usage waldur_mastermind.marketplace.calculate_usage_for_current_month 1 hour Calculate marketplace resource usage for the current month across all customers and projects.
waldur-marketplace-script-pull-resources waldur_marketplace_script.pull_resources 1 hour Pull resources from marketplace script offerings by executing configured pull scripts.
waldur-marketplace-script-remove-old-dry-runs waldur_marketplace_script.remove_old_dry_runs 1 day Remove old dry run records that are older than one day.
waldur-mastermind-reject-past-bookings waldur_mastermind.booking.reject_past_bookings Cron: 0 10 * * * (m/h/dM/MY/d) Reject booking resources that have start times in the past.
waldur-mastermind-send-notifications-about-upcoming-bookings waldur_mastermind.booking.send_notifications_about_upcoming_bookings Cron: 0 9 * * * (m/h/dM/MY/d) Send email notifications to users about their upcoming bookings.
waldur-pid-update-all-referrables waldur_pid.update_all_referrables 1 day Update DataCite DOI information for all referrable objects with existing DOIs.
waldur-pull-remote-eduteams-ssh-keys waldur_auth_social.pull_remote_eduteams_ssh_keys 3 minutes Task not found in registry
waldur-pull-remote-eduteams-users waldur_auth_social.pull_remote_eduteams_users 5 minutes Task not found in registry
waldur-rancher-delete-leftover-keycloak-groups waldur_rancher.delete_leftover_keycloak_groups 1 hour Delete remote Keycloak groups with no linked groups in Waldur
waldur-rancher-delete-leftover-keycloak-memberships waldur_rancher.delete_leftover_keycloak_memberships 1 hour Delete remote Keycloak user memberships in groups with no linked instances in Waldur
waldur-rancher-sync-keycloak-users waldur_rancher.sync_keycloak_users 15 minutes Synchronize Keycloak users with pending group memberships in Rancher.
waldur-rancher-sync-rancher-group-bindings waldur_rancher.sync_rancher_group_bindings 1 hour Sync group bindings in Rancher with the groups in Waldur.
waldur-rancher-sync-rancher-roles waldur_rancher.sync_rancher_roles 1 hour Synchronize Rancher roles with local role templates for clusters and projects.
waldur-rancher-update-clusters-nodes waldur_rancher.pull_all_clusters_nodes 1 day Pull node information for all Rancher clusters and update their states.
waldur-remote-notify-about-pending-project-update-requests waldur_mastermind.marketplace_remote.notify_about_pending_project_update_requests 7 days Notify about pending project update requests.

This task sends email notifications to project owners about pending
project update requests that have been waiting for more than a week.
Runs weekly via celery beat.
waldur-remote-offerings-sync waldur_mastermind.marketplace_remote.remote_offerings_sync 1 day Synchronize remote offerings based on RemoteSynchronisation configurations.

This task processes active remote synchronization configurations,
running synchronization for each configured remote marketplace.
Runs daily via celery beat.
waldur-remote-pull-erred-orders waldur_mastermind.marketplace_remote.pull_erred_orders 1 day Pull and synchronize erred remote marketplace orders.

This task specifically handles erred local orders that may have been
resolved in remote Waldur instances. It synchronizes UPDATE and TERMINATE
order states and adjusts local resource states accordingly.
Runs daily via celery beat.
waldur-remote-pull-invoices waldur_mastermind.marketplace_remote.pull_invoices 1 hour Pull and synchronize remote marketplace resource invoice data.

This task synchronizes invoice items for marketplace resources from
remote Waldur instances, including current and previous month data.
Runs every 60 minutes via celery beat.
waldur-remote-pull-maintenance-announcements waldur_mastermind.marketplace_remote.pull_maintenance_announcements 1 hour Pull and synchronize remote maintenance announcements.

This task synchronizes maintenance announcements from remote Waldur instances,
Runs every 60 minutes via celery beat.
waldur-remote-pull-offering-users waldur_mastermind.marketplace_remote.pull_offering_users 1 hour Pull and synchronize remote marketplace offering users.

This task synchronizes user associations with marketplace offerings from
remote Waldur instances, ensuring local user mappings are up to date.
Runs every 60 minutes via celery beat.
waldur-remote-pull-offerings waldur_mastermind.marketplace_remote.pull_offerings 1 hour Pull and synchronize remote marketplace offerings.

This task synchronizes offerings from remote Waldur instances, updating
local offering data including components, plans, and access endpoints.
Runs every 60 minutes via celery beat.
waldur-remote-pull-orders waldur_mastermind.marketplace_remote.pull_orders 1 hour Pull and synchronize remote marketplace orders.

This task synchronizes order states from remote Waldur instances,
updating local order states and associated resource backend IDs.
Only processes non-terminal orders. Runs every 60 minutes via celery beat.
waldur-remote-pull-resources waldur_mastermind.marketplace_remote.pull_resources 1 hour Pull and synchronize remote marketplace resources.

This task synchronizes resource data from remote Waldur instances,
updating local resource states and importing remote orders when needed.
Runs every 60 minutes via celery beat.
waldur-remote-pull-robot-accounts waldur_mastermind.marketplace_remote.pull_robot_accounts 1 hour Pull and synchronize remote marketplace resource robot accounts.

This task synchronizes robot account data for marketplace resources from
remote Waldur instances, including account types, usernames, and keys.
Runs every 60 minutes via celery beat.
waldur-remote-pull-usage waldur_mastermind.marketplace_remote.pull_usage 1 hour Pull and synchronize remote marketplace resource usage data.

This task synchronizes component usage data from remote Waldur instances,
including both regular usage and user-specific usage metrics.
Pulls usage data from the last 4 months. Runs every 60 minutes via celery beat.
waldur-remote-push-project-data waldur_mastermind.marketplace_remote.push_remote_project_data 1 day Push project data to remote Waldur instances.

This task pushes local project data (name, description, end date, etc.)
to remote Waldur instances for projects that have marketplace resources.
Runs daily via celery beat.
waldur-remote-sync-remote-project-permissions waldur_mastermind.marketplace_remote.sync_remote_project_permissions 6 hours Synchronize project permissions with remote Waldur instances.

This task ensures that project permissions are synchronized between
local and remote Waldur instances when eduTEAMS sync is enabled.
It creates remote projects if needed and manages user role assignments.
Runs every 6 hours via celery beat.
waldur-sync-daily-quotas analytics.sync_daily_quotas 1 day Task not found in registry
waldur-update-all-pid waldur_pid.update_all_pid 1 day Update all PID (Persistent Identifier) information for referrable objects with DataCite DOIs.
waldur_mastermind.marketplace_rancher.sync_managed_rancher_invoice_items waldur_mastermind.marketplace_rancher.sync_managed_rancher_invoice_items 1 hour No description available

Message templates

waldur_core.structure

notifications_profile_changes_operator_subject.txt (waldur_core.structure)

1
Owner details have been updated

notifications_profile_changes.html (waldur_core.structure)

1
2
3
4
5
User {{user.full_name}} (id={{ user.id }}) profile has been updated:

{% for f in fields %}
    {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
{% endfor %}

change_email_request_subject.txt (waldur_core.structure)

1
Verify new email address.

notifications_profile_changes_operator_message.html (waldur_core.structure)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Owner of
{% for o in organizations %}
    {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
{% endfor %}

{{user.full_name}} (id={{ user.id }}) has changed

{% for f in fields %}
    {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
{% endfor %}

structure_role_granted_message.txt (waldur_core.structure)

1
Role {{ permission.role }}  for {{ structure }} has been granted.

structure_role_granted_subject.txt (waldur_core.structure)

1
Role granted.

change_email_request_message.html (waldur_core.structure)

1
<p>To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the <a href="{{ link }}">link</a>.</p>

change_email_request_message.txt (waldur_core.structure)

1
To confirm the change of email address from {{ request.user.email }} to {{ request.email }}, follow the {{ link }}.

notifications_profile_changes_operator_message.txt (waldur_core.structure)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Owner of
{% for o in organizations %}
    {{ o.name }} {% if o.abbreviation %} ({{ o.abbreviation }}){% endif %}{% if not forloop.last %}, {% endif %}
{% endfor %}

{{user.full_name}} (id={{ user.id }}) has changed

{% for f in fields %}
    {{ f.name }} from {{ f.old_value }} to {{ f.new_value }}{% if not forloop.last %}, {% else %}.{% endif %}
{% endfor %}

structure_role_granted_message.html (waldur_core.structure)

1
<p>Role {{ permission.role }}  for {{ structure }} has been granted.</p>

waldur_core.users

invitation_approved_subject.txt (waldur_core.users)

1
Account has been created

invitation_created_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Invitation to {{ name }} {{ type }}</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
    Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
    Please note: this invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}!
</p>
<p>
    {{ extra_invitation_text }}
</p>
</body>
</html>

permission_request_submitted_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
<html>
<head lang="en">
  <meta charset="UTF-8">
  <title>Permission request has been submitted.</title>
</head>
<body>
<p>
  Hello!
</p>
<p>
  User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.
</p>
<p>
  Please visit the <a href="{{ requests_link }}">link</a> to approve or reject permission request.
</p>
</body>
</html>

invitation_approved_message.txt (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
Hello!

{{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
Please visit the link below to sign up and accept your invitation:
{{ link }}

Your credentials are as following.

Username is {{ username }}

Your password is {{ password }}

invitation_created_message.txt (waldur_core.users)

1
2
3
4
5
6
Hello!

{{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.
Please visit the link below to sign up and accept your invitation:
{{ link }}
{{ extra_invitation_text }}

invitation_expired_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Invitation to {{ invitation.email }} has expired</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    An invitation to {{ invitation.email }} has expired <br>
    An invitation to {{ invitation.email }} has expired at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

</p>
</body>
</html>

invitation_approved_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Account has been created</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    {{ sender }} has invited you to join {{ name }} {{ type }} in {{ role }} role.<br>
    Please visit <a href="{{ link }}">this page</a> to sign up and accept your invitation.
</p>
<p>
  Your credentials are as following.
</p>
<p>
  Your username is {{ username }}
</p>
<p>
  Your password is {{ password }}
</p>
</body>
</html>

invitation_expired_subject.txt (waldur_core.users)

1
Invitation has expired

invitation_expired_message.txt (waldur_core.users)

1
2
3
4
Hello!

An invitation to {{ invitation.email }} has expired.
This invitation expires at {{ invitation.get_expiration_time|date:'d.m.Y H:i' }}.

invitation_rejected_message.txt (waldur_core.users)

1
2
3
4
5
6
7
8
9
Hello!

The following invitation has been rejected.

Full name: {{ invitation.full_name }}

Target: {{ name }} {{ type }}

Role: {{ role }}

invitation_rejected_subject.txt (waldur_core.users)

1
Invitation has been rejected

invitation_created_subject.txt (waldur_core.users)

1
2
3
4
5
{% if reminder %}
REMINDER: Invitation to {{ name }} {{ type }}
{% else %}
Invitation to {{ name }} {{ type }}
{% endif %}

permission_request_submitted_subject.txt (waldur_core.users)

1
Permission request has been submitted.

invitation_requested_message.txt (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Hello!

{{ sender }} has created invitation request for the following user
to join {{ name }} {{ type }} in {{ role }} role.

{% if invitation.civil_number %}
Civil number: {{ invitation.civil_number }}
{% endif %}

{% if invitation.phone_number %}
Phone number: {{ invitation.phone_number }}
{% endif %}

E-mail: {{ invitation.email }}

{% if invitation.full_name %}
Full name: {{ invitation.full_name }}
{% endif %}

{% if invitation.native_name %}
Native name: {{ invitation.native_name }}
{% endif %}

{% if invitation.organization %}
Organization: {{ invitation.organization }}
{% endif %}

{% if invitation.job_title %}
Job title: {{ invitation.job_title }}
{% endif %}

Please visit the link below to approve invitation: {{ approve_link }}

Alternatively, you may reject invitation: {{ reject_link }}

invitation_rejected_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Invitation to {{ name }} {{ type }}</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
  The following invitation has been rejected.
</p>

<p>
  Full name: {{ invitation.full_name }}
</p>

<p>
  Target: {{ name }} {{ type }}
</p>

<p>
  Role: {{ role }}
</p>
</body>
</html>

permission_request_submitted_message.txt (waldur_core.users)

1
2
3
4
5
Hello!

User {{ permission_request.created_by }} with email {{ permission_request.created_by.email }} created permission request for {{ permission_request.invitation }}.

Please visit the link below to approve or reject permission request: {{ requests_link }}.

invitation_requested_message.html (waldur_core.users)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<html>
<head lang="en">
  <meta charset="UTF-8">
  <title>Invitation request</title>
</head>
<body>
<p>
  Hello!
</p>
<p>
  {{ sender }} has created invitation request for the following user
  to join {{ name }} {{ type }} in {{ role }} role.
</p>

{% if invitation.civil_number %}
  <p>
    Civil number: {{ invitation.civil_number }}
  </p>
{% endif %}

{% if invitation.phone_number %}
  <p>
    Phone number: {{ invitation.phone_number }}
  </p>
{% endif %}

<p>
  E-mail: {{ invitation.email }}
</p>

{% if invitation.full_name %}
  <p>
    Full name: {{ invitation.full_name }}
  </p>
{% endif %}

{% if invitation.native_name %}
  <p>
    Native name: {{ invitation.native_name }}
  </p>
{% endif %}

{% if invitation.organization %}
  <p>
    Organization: {{ invitation.organization }}
  </p>
{% endif %}

{% if invitation.job_title %}
  <p>
    Job title: {{ invitation.job_title }}
  </p>
{% endif %}

<p>
  Please <a href="{{ approve_link }}">approve</a> or <a href="{{ reject_link }}">reject</a> invitation.
</p>
</body>
</html>

invitation_requested_subject.txt (waldur_core.users)

1
Invitation request

waldur_core.logging

email.html (waldur_core.logging)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Notifications from waldur_core</title>
</head>
<body>
<ul>
    {% for event in events %}
    <li>
        {{ event.message }}
        <div>{{ event.created|date:"M d H:i e"}}</div>
    </li>
    {% endfor %}
</ul>
</body>
</html>

waldur_mastermind.booking

notification_message.txt (waldur_mastermind.booking)

1
2
3
4
5
6
Hello!

Please do not forget about upcoming booking:
{% for resource in resources %}
    {{ resource.name }}{% if not forloop.last %}, {% endif %}
{% endfor %}.

notification_message.html (waldur_mastermind.booking)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about upcoming booking.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Please do not forget about upcoming booking: <br />
    {% for resource in resources %}
        {{ resource.name }}
        {% if not forloop.last %}
            <br />
        {% endif %}
    {% endfor %}
</p>
</body>
</html>

notification_subject.txt (waldur_mastermind.booking)

1
Reminder about upcoming booking.

waldur_mastermind.invoices

monthly_invoicing_reports.html (waldur_mastermind.invoices)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{% load i18n %}
{% load static %}
{% load humanize %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <style type="text/css">
        {% include "./style.css" %}
    </style>
</head>
<body>
<h2>{% trans 'Fixed price contracts:' %}</h2>
{% if contracts %}
    <table class="invoice-table">
        <thead>
            <tr>
                <th></th>
                <th>{% trans 'Organization' %}</th>
                <th>{% trans 'Contract end date' %}</th>
                <th>{% trans 'Till the end of contract. [days]' %}</th>
                <th>{% trans 'Contract sum' %}</th>
                <th>{% trans 'Payment sum' %}</th>
            </tr>
        </thead>
        <tbody>
            {% for contract in contracts %}
                <tr>
                    <th>{{ forloop.counter }}</th>
                    <td>{{ contract.name }}</td>
                    <td>{{ contract.end|date:"Y-m-d"|default_if_none:"" }}</td>
                    <td {% if contract.end_date_alarm %} class="text-danger" {% endif %}>{{ contract.till_end|default_if_none:"" }}</td>
                    <td {% if contract.payments_alarm %} class="text-danger" {% endif %}>
                        {{ contract.contract_sum|default_if_none:0|floatformat:"2"|intcomma }}
                    </td>
                    <td {% if contract.payments_alarm %} class="text-danger" {% endif %}>
                        {{ contract.payments_sum|default_if_none:0|floatformat:"2"|intcomma }}
                    </td>
                </tr>
            {% endfor %}
        </tbody>
    </table>
{% else %}
    <p>{% trans 'Contracts do not exist.' %}</p>
{% endif %}

<h2>{% blocktrans %}Invoices for month {{ month }}-{{ year }}:{% endblocktrans %}</h2>

<table class="invoice-table">
    <thead>
        <tr>
            <th></th>
            <th>{% trans 'Organization' %}</th>
            <th>{% trans 'Invoice date' %}</th>
            <th>{% trans 'Invoice sum' %}</th>
        </tr>
    </thead>
    <tbody>
        {% for invoice in invoices %}
            <tr>
                <th>{{ forloop.counter }}</th>
                <td>{% if invoice.customer.abbreviation %}
                        {{ invoice.customer.abbreviation }}
                    {% else %}
                        {{ invoice.customer.name }}
                    {% endif %}</td>
                <td>{{ invoice.invoice_date|date:"Y-m-d" }}</td>
                <td>{{ invoice.total|floatformat:"2"|intcomma }}</td>
            </tr>
        {% endfor %}
    </tbody>
</table>

</body>
</html>

report_body.txt (waldur_mastermind.invoices)

1
Attached is an accounting report for {{ month }}/{{ year }}.

invoice.html (waldur_mastermind.invoices)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{% load i18n %}
{% load humanize %}

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Invoice</title>
    <style type="text/css">
      {% include "waldur_core/font.css" %}
      {% include "./style.css" %}
    </style>
  </head>
  <body>
      {% if deployment_logo %}
      <div id="logo">
        <img src="data:image/png;base64,{{ deployment_logo }}">
      </div>
      {% endif %}
      <h1>{% trans "Invoice No." %} {{ invoice.number|upper }}</h1>
      <br>
      <div class="text-right">
          <strong>{% trans "Invoice date" %}:</strong> {% if invoice.invoice_date %}
        {{ invoice.invoice_date|date:"Y-m-d" }} {% else %} {% trans "Pending" %} {% endif %}<br/>
          {% if invoice.due_date %}<strong>{% trans "Due date" %}:</strong> {{ invoice.due_date|date:"Y-m-d" }}<br/>{% endif %}
          <strong>{% trans "Invoice period" %}:</strong> {{ invoice.year }}-{{ invoice.month }}<br/>
      </div>

      <div>
        <h3 class="name">From</h3>
        <div><strong>{{ issuer_details.company }}</strong></div>
        <div>{{ issuer_details.address }}</div>
        <div>{{ issuer_details.country }}, {{ issuer_details.postal }}</div>
        <div><abbr>P:</abbr> ({{ issuer_details.phone.country_code }}) {{ issuer_details.phone.national_number }}</div>
        <div>{{ issuer_details.bank }}, {{ issuer_details.account }}</div>
        <div><abbr>{% trans "VAT" %}:</abbr>{{ issuer_details.vat_code }}</div>
        <div>{{ issuer_details.email }}</div>
      </div>
      <div>
        <h3 class="name">To</h3>
        <div><strong>{{ invoice.customer.name }}</strong></div>

        {% if invoice.customer.address %}
          <div>{{ invoice.customer.address }}</div>
        {% endif %}

        {% if invoice.customer.country and invoice.customer.postal %}
          <div>{{ invoice.customer.country }}, {{ invoice.customer.postal }}</div>
        {% endif %}

        {% if invoice.customer.phone_number %}
          <div><abbr>P:</abbr> {{ invoice.customer.phone_number }}</div>
        {% endif %}

        {% if invoice.customer.bank_name and invoice.customer.bank_account %}
          <div>{{ invoice.customer.bank_name }}, {{ invoice.customer.bank_account }}</div>
        {% endif %}

        {% if customer.vat_code %}
          <div><abbr>{% trans "VAT" %}:</abbr> {{ customer.vat_code }}</div>
        {% endif %}

        <div>{{ invoice.customer.email }}</div>

      </div>
      <div class="m-t">
        <table class="invoice-table">
          <tr>
            <th>Item</th>
            <th>Quantity</th>
            <th>Unit price</th>
            <th>Total price</th>
          </tr>

          {% regroup items|dictsort:"project_name" by project_name as project_list %}
          {% for project in project_list %}
          <tr>
              <td colspan="4"><h3>{{ project.grouper }}</h3></td>
          </tr>
            {% for item in project.list %}
              <tr>
                <td>
                  <strong>{{ item.name }}</strong>
                  <div>
                    <small>
                      {% trans "Start time" %}: {{ item.start | date:"Y-m-d H:i" }}.
                      {% trans "End time" %}: {{ item.end | date:"Y-m-d H:i" }}.
                    </small>
                  </div>
                </td>
                <td>{{ item.quantity }}</td>
                <td>{{ currency }} {{ item.unit_price | floatformat:2 | intcomma }}</td>
                <td>{{ currency }} {{ item.total | floatformat:2 | intcomma }}</td>
              </tr>
            {% endfor %}
          {% endfor %}
        </table>
      </div>
      <table class="m-t invoice-total">
        <tr>
          <td><strong>{% trans "Subtotal" %}</strong></td>
          <td>{{ currency }} {{ invoice.price | floatformat:2 | intcomma}}</td>
        </tr>
        {% if invoice.tax %}
          <tr>
            <td><strong>{% trans "VAT" %}</strong></td>
            <td>{{ currency }} {{ invoice.tax | floatformat:2 | intcomma}}</td>
          </tr>
        {% endif %}
        <tr>
          <td><strong>{% trans "TOTAL" %}</strong></td>
          <td>{{ currency }} {{ invoice.total | floatformat:2 | intcomma}}</td>
      </tr>
      </table>
  </body>
</html>

notification_message.txt (waldur_mastermind.invoices)

1
2
3
4
Hello,

Please follow the link below to see {{ customer }}'s accounting information for {{ month }}/{{ year }}:
{{ link }}

upcoming_ends_notification_message.txt (waldur_mastermind.invoices)

1
2
3
Hello,

this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.

upcoming_ends_notification_subject.txt (waldur_mastermind.invoices)

1
{{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end

report_subject.txt (waldur_mastermind.invoices)

1
Waldur accounting report for {{ month }}/{{ year }}

notification_message.html (waldur_mastermind.invoices)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html xmlns="http://www.w3.org/1999/html">
<head lang="en">
    <meta charset="UTF-8">
    <title>{{ customer }}'s invoice for {{ month }}/{{ year }}</title>
</head>
<body>
<p>
    Dear Sir or Madam,
</p>
<p>
    Attached is invoice for services consumed by {{ customer }}'s during {{ month }}/{{ year }}.
</p>
</body>
</html>

upcoming_ends_notification_message.html (waldur_mastermind.invoices)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>{{ organization_name }}'s fixed price contract {{ contract_number }} is coming to an end.</title>
</head>
<body>
<p>
    Hello,
    <br/>
    this is a reminder that {{ organization_name }}'s fixed price contract {{ contract_number }} is ending on {{ end }}.
</p>
</body>
</html>

notification_subject.txt (waldur_mastermind.invoices)

1
{{ customer }}'s invoice for {{ month }}/{{ year }}

waldur_mastermind.marketplace

notification_about_project_ending_subject.txt (waldur_mastermind.marketplace)

1
{% if count_projects > 1 %}Your {{ count_projects }} projects{% else %} Project{% endif %} will be deleted on {{ end_date|date:'d/m/Y' }}.

marketplace_resource_update_limits_succeeded_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
Hello!

Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:
    {{ resource_old_limits }}
to:
    {{ resource_limits }}.

{% if support_email or support_phone %}
If you have any additional questions, please contact support.
{% if support_email %}
Email: {{ support_email }}
{% endif %}
{% if support_phone %}
Phone: {{ support_phone }}
{% endif %}
{% endif %}

marketplace_resource_update_limits_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} limits have been updated.

notification_about_stale_resources_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Hello!

We noticed that you have stale resources that have not cost you anything for the last 3 months.
Perhaps some of them are not needed any more?

The resource names are:
{% for resource in resources %}
    {{ resource.resource.name }} {{ resource.resource_url }}
{% endfor %}
Thank you!

marketplace_plan_template.txt (waldur_mastermind.marketplace)

1
2
3
Plan: {{ plan.name }}{% for component in components %}
{{component.name}}; amount: {{component.amount}}; price: {{component.price|floatformat }};
{% endfor %}

notification_usages_message.txt (waldur_mastermind.marketplace)

1
2
3
4
5
6
7
8
Hello!

Please do not forget to add usage for the resources you provide:
{% regroup resources by offering as offering_list %}{% for offering in offering_list %}
{{forloop.counter}}. {{ offering.grouper.name }}:{% for resource in offering.list %}
    - {{ resource.name }}
{% endfor %}{% endfor %}
You can submit resource usage via API or do it manually at {{ public_resources_url }}.

notify_consumer_about_pending_order_subject.txt (waldur_mastermind.marketplace)

1
A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_termination_scheduled_staff_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource.name }} termination has been scheduled.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
    If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
</p>
</body>
</html>

marketplace_resource_update_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} has been updated.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Following request from {{ order_user }}, resource {{ resource_name }} has been updated.
</p>
{% if resource_old_plan %}
<p>
    The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
</p>
{% endif %}
{% if support_email or support_phone %}
<p>
    If you have any additional questions, please contact support.
</p>
{% if support_email %}
<p>
    Email: {{ support_email }}
</p>
{% endif %}
{% if support_phone %}
<p>
    Phone: {{ support_phone }}
</p>
{% endif %}
{% endif %}
</body>
</html>

marketplace_resource_update_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} update has failed.

notify_provider_about_pending_order_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Please visit <a href="{{ order_url }}">{{ site_name }}</a> to find out more details.
</p>
</body>
</html>

marketplace_resource_terminate_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} deletion has failed.

marketplace_resource_update_succeeded_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
Hello!

Following request from {{ order_user }}, resource {{ resource_name }} has been updated.

{% if resource_old_plan %}
The plan has been changed from {{ resource_old_plan }} to {{ resource_plan }}.
{% endif %}

{% if support_email or support_phone %}
If you have any additional questions, please contact support.
{% if support_email %}
Email: {{ support_email }}
{% endif %}
{% if support_phone %}
Phone: {{ support_phone }}
{% endif %}
{% endif %}

notification_to_user_that_order_been_rejected_subject.txt (waldur_mastermind.marketplace)

1
Your order to {{ order_type }} a resource {{ order.resource.name }} has been rejected.

marketplace_resource_update_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} update has failed.

notification_about_stale_resources_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about stale resources.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    We noticed that you have stale resources that have not cost you anything for the last 3 months. <br />
    Perhaps some of them are not needed any more?<br />

    The resource names are:
    <ul>
        {% for resource in resources %}
            <li><a href='{{ resource.resource_url }}'>{{ resource.resource.name }}</a></li>
        {% endfor %}
    </ul>
    Thank you!
</p>
</body>
</html>

marketplace_resource_create_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} creation has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} creation has failed.
</p>
</body>
</html>

notify_consumer_about_pending_order_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_create_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} has been created.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} has been created.
</p>
</body>
</html>

marketplace_resource_update_limits_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} limits update has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} limits update has failed.
</p>
</body>
</html>

marketplace_resource_update_limits_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} limits have been updated.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Following request from {{ order_user }}, resource {{ resource_name }} limits have been updated from:<br>
    <blockquote>
        {{ resource_old_limits }}
    </blockquote>
    to:
    <blockquote>
        {{ resource_limits }}
    </blockquote>
</p>
{% if support_email or support_phone %}
<p>
    If you have any additional questions, please contact support.
</p>
{% if support_email %}
<p>
    Email: {{ support_email }}
</p>
{% endif %}
{% if support_phone %}
<p>
    Phone: {{ support_phone }}
</p>
{% endif %}
{% endif %}
</body>
</html>

marketplace_resource_update_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} update has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} update has failed.
</p>
</body>
</html>

notification_about_resource_ending_message.txt (waldur_mastermind.marketplace)

1
2
3
4
5
6
7
Dear {{ user.full_name }},

Termination date of your {{ resource.name }} is approaching and it will be deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.
If you are aware of that, then no actions are needed from your side.
If you need to update resource end date, please update it in resource details {{ resource_url }}.

Thank you!

notification_about_project_ending_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Projects will be deleted.</title>
</head>
<body>
<p>Hello {{ user.full_name }}!</p>
<p>The following projects are ending {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}:</p>
<ul>
{% for project in projects %}
    <li><a href="{{ project.url }}">{{ project.name }}</a></li>
{% endfor %}
</ul>
<p>
    End of the project will lead to termination of all resources in the project. <br />
    If you are aware of that, then no actions are needed from your side. <br />
    If you need to update project end date, please update it in project details.
</p>
<p>Thank you!</p>
</body>
</html>

marketplace_resource_create_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} creation has failed.

marketplace_resource_update_limits_failed_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} limits update has failed.

marketplace_resource_terminate_failed_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} deletion has failed.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} deletion has failed.
</p>
</body>
</html>

notification_usages_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about missing usage reports.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>Please do not forget to add usage for the resources you provide:</p>
{% regroup resources by offering as offering_list %}

<ol>
{% for offering in offering_list %}
    <li>
        {{ offering.grouper.name }}:
        <ul>
            {% for resource in offering.list %}
            <li>{{ resource.name }}</li>
            {% endfor %}
        </ul>
    </li>
{% endfor %}
</ol>

<p>
    You can submit resource usage via API or do it <a href='{{ public_resources_url }}'>manually</a>.
</p>
</body>
</html>

marketplace_resource_terminate_succeeded_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource_name }} has been deleted.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Resource {{ resource_name }} has been deleted.
</p>
</body>
</html>

marketplace_resource_termination_scheduled_staff_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource.name }} termination has been scheduled.

notification_about_stale_resources_subject.txt (waldur_mastermind.marketplace)

1
Reminder about stale resources.

notify_provider_about_pending_order_subject.txt (waldur_mastermind.marketplace)

1
A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_terminate_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} has been deleted.

marketplace_resource_termination_scheduled_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

notification_about_resource_ending_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource.name }} will be deleted.</title>
</head>
<body>
<p>Dear {{ user.full_name }},</p>

<p>
    Termination date of your {{ resource.name }} is approaching and it will be
    deleted{% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}.<br />
    If you are aware of that, then no actions are needed from your side. <br />
    If you need to update resource end date, please update it in resource details {{ resource_url }}.
</p>

<p>Thank you!</p>
</body>
</html>

notification_about_project_ending_message.txt (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
Hello {{ user.full_name }}!

The following projects are ending {% if delta == 1 %} tomorrow {% else %} in {{ delta }} days{% endif %}:

{% for project in projects %}
    - {{ project.name }} ({{ project.url }})
{% endfor %}

End of the project will lead to termination of all resources in the project.
If you are aware of that, then no actions are needed from your side.
If you need to update project end date, please update it in project details.

Thank you!

notification_to_user_that_order_been_rejected_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Your order {{ link }} to {{ order_type }} a resource {{ order.resource.name }} has been rejected.

notification_about_resource_ending_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource.name }} will be deleted.

marketplace_resource_update_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} has been updated.

marketplace_resource_update_limits_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} limits update has failed.

marketplace_resource_termination_scheduled_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource.name }} termination has been scheduled.

notify_consumer_about_pending_order_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>A new order by {{ order.created_by.get_full_name }} is waiting for approval.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Please visit <a href="{{ order_link }}">{{ site_name }}</a> to find out more details.
</p>
</body>
</html>

marketplace_resource_terminate_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} deletion has failed.

marketplace_resource_termination_scheduled_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Resource {{ resource.name }} termination has been scheduled.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    The resource you have - <a href="{{ resource_url }}">{{ resource.name }}</a> has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}.
    If you feel that you still want to keep it, please <a href="{{ resource_url }}"></a>remove the resource end date</a>.
</p>
</body>
</html>

notification_to_user_that_order_been_rejected_message.html (waldur_mastermind.marketplace)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Your order has been rejected.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    Your <a href="{{ link }}">order</a> to {{ order_type }} a resource {{ order.resource.name }} has been rejected.
</p>
</body>
</html>

marketplace_resource_create_failed_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} creation has failed.

marketplace_resource_termination_scheduled_staff_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

The resource you have - {{ resource.name }} has not been used for the past 3 months. {{ user.full_name }} has scheduled termination of that resource on {{ resource.end_date|date:"SHORT_DATE_FORMAT" }}. If you feel that you still want to keep it, please remove the resource end date {{ resource_url }}.

marketplace_resource_create_succeeded_subject.txt (waldur_mastermind.marketplace)

1
Resource {{ resource_name }} has been created.

marketplace_resource_terminate_succeeded_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} has been deleted.

notify_provider_about_pending_order_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

A new order by {{ order.created_by.get_full_name }} is waiting for approval.

marketplace_resource_create_succeeded_message.txt (waldur_mastermind.marketplace)

1
2
3
Hello!

Resource {{ resource_name }} has been created.

notification_usages_subject.txt (waldur_mastermind.marketplace)

1
Reminder about missing usage reports.

waldur_mastermind.marketplace_remote

notification_about_pending_project_updates_message.txt (waldur_mastermind.marketplace_remote)

1
2
3
4
5
6
7
8
Hello!

We noticed that you have pending project update requests.
Perhaps you would like to have a look at them?

The project is:
    {{ project_update_request.project.name }} {{ project_url }}
Thank you!

notification_about_pending_project_updates_subject.txt (waldur_mastermind.marketplace_remote)

1
Reminder about pending project updates.

notification_about_project_details_update_message.txt (waldur_mastermind.marketplace_remote)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Hello!

We would like to notify you about recent updates in project details.
Perhaps you would like to have a look at them?

The project is:
    {{ new_name }} {{ project_url }}

    Details after the update are below:
        {% if new_description %}
            Old description: {{ old_description }}
            New description: {{ new_description }}
        {% endif %}

        {% if new_name %}
            Old name: {{ old_name }}
            New name: {{ new_name }}
        {% endif %}

        {% if new_end_date %}
           Old end date: {{ old_end_date }}
           New end date: {{ new_end_date }}
        {% endif %}

        {% if new_oecd_fos_2007_code %}
           Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}
           New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}
        {% endif %}

        {% if new_is_industry %}
           Old is_industry: {{ old_is_industry }}
           New is_industry: {{ new_is_industry }}
        {% endif %}

    Reviewed by: {{ reviewed_by }}
Thank you!

notification_about_project_details_update_message.html (waldur_mastermind.marketplace_remote)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>A notification about project details update.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    We would like to notify you about recent updates in project details.<br />
    Perhaps you would like to have a look at them?<br />

    The project is:
    <ul>
        <li><a href='{{ project_url }}'>{{ new_name }}</a></li>
    </ul>

    <div>
        Details after the update are below:
        <ul>
            {% if new_description %}
                <li>Old description: {{ old_description }}</li>
                <li>New description: {{ new_description }}</li>
            {% endif %}

            {% if new_name %}
                <li>Old name: {{ old_name }}</li>
                <li>New name: {{ new_name }}</li>
            {% endif %}

            {% if new_end_date %}
                <li>Old end date: {{ old_end_date }}</li>
                <li>New end date: {{ new_end_date }}</li>
            {% endif %}

            {% if new_oecd_fos_2007_code %}
                <li>Old OECD FOS 2007 code: {{ old_oecd_fos_2007_code }}</li>
                <li>New OECD FOS 2007 code: {{ new_oecd_fos_2007_code }}</li>
            {% endif %}

            {% if new_is_industry %}
                <li>Old is_industry: {{ old_is_industry }}</li>
                <li>New is_industry: {{ new_is_industry }}</li>
            {% endif %}
            <li>Reviewed by: {{ reviewed_by }}</li>
        </ul>

    </div>
    Thank you!
</p>
</body>
</html>

notification_about_pending_project_updates_message.html (waldur_mastermind.marketplace_remote)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>Reminder about pending project updates.</title>
</head>
<body>
<p>
    Hello!
</p>
<p>
    We noticed that you have pending project update requests.<br />
    Perhaps you would like to have a look at them?<br />

    The project is:
    <ul>
        <li><a href='{{ project_url }}'>{{ project_update_request.project.name }}</a></li>
    </ul>
    Thank you!
</p>
</body>
</html>

notification_about_project_details_update_subject.txt (waldur_mastermind.marketplace_remote)

1
A notification about project details update.

waldur_mastermind.marketplace_support

create_project_membership_update_issue.txt (waldur_mastermind.marketplace_support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
User: {{user.first_name}} {{user.last_name}} (e-mail: {{user.email}}, username: {{user.username}}).
Project: {{project}} ({{ project_url }}).

Service offerings:
{% for offering in offerings %} {{offering}}
    {% if offering.offering_user %}Offering user: {{offering.offering_user.username}}
    {% else %}
    Username not available.
    {% endif %}
    {% if offering.resources %}Resources:
        {% for resource in offering.resources %}- name: {{resource.name}}, backend ID: {{resource.backend_id}}, link: {{resource.get_homeport_link}}
        {% endfor %}
    {% endif %}
{% endfor %}

terminate_resource_template.txt (waldur_mastermind.marketplace_support)

1
2
3
{% load waldur_marketplace %}[Terminate resource {{order.resource.scope.name}}|{{request_url}}].
{% plan_details order.resource.plan %}
Marketplace resource UUID: {{order.resource.uuid.hex}}

update_resource_template.txt (waldur_mastermind.marketplace_support)

1
2
3
[Switch plan for resource {{order.resource.scope.name}}|{{request_url}}].
Switch from {{order.resource.plan.name}} plan to {{order.plan.name}}.
Marketplace resource UUID: {{order.resource.uuid.hex}}

create_resource_template.txt (waldur_mastermind.marketplace_support)

1
2
3
4
5
6
7
8
9
{% load waldur_marketplace %}[Order|{{order_url}}].
Provider: {{order.offering.customer.name}}
Resource UUID: {{resource.uuid}}
Resource name: {{resource.name}}
Plan details:
    {% plan_details order.plan %}
Full name: {{order.created_by.full_name|default:"none"}}
Civil code: {{order.created_by.civil_number|default:"none"}}
Email: {{order.created_by.email}}

update_limits_template.txt (waldur_mastermind.marketplace_support)

1
2
3
4
[Update limits for resource {{order.resource.scope.name}}|{{request_url}}].
Marketplace resource UUID: {{order.resource.uuid.hex}}
Old limits: {{ old_limits }}.
New limits: {{ new_limits }}.

waldur_mastermind.proposal

review_rejected_subject.txt (waldur_mastermind.proposal)

1
Alert: review assignment rejected for {{ proposal_name }}

proposal_decision_for_reviewer_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
Dear {{ reviewer_name }},

A decision has been made on the proposal "{{ proposal_name }}" in call "{{ call_name }}" that you reviewed.

Decision details:
- Proposal: {{ proposal_name }}
- Decision: {{ proposal_state }}
- Decision date: {{ decision_date }}

{% if proposal_state == "rejected" and rejection_reason %}Reason: {{ rejection_reason }}{% endif %}

Thank you for your valuable contribution to the review process. Your expert assessment helped inform this decision.

View proposal: {{ proposal_url }}

This is an automated message from {{ site_name }}. Please do not reply to this email.

proposal_state_changed_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Dear {{ proposal_creator_name }},

The state of your proposal "{{ proposal_name }}" in call "{{ call_name }}" has been updated.

State change:
- Previous state: {{ previous_state }}
- New state: {{ new_state }}
- Updated on: {{ update_date }}

{% if new_state == 'accepted' %}
Project created: {{ project_name }}
Allocation start date: {{ allocation_date }}
Duration: {{ duration }} days

Allocated resources:
{% for resource in allocated_resources %}
{{ forloop.counter }}. {{ resource.name }} - {{ resource.provider_name }} - {{ resource.plan_name }} - Provisioned
{% empty %}
No resources allocated yet.
{% endfor %}
{% endif %}

{% if new_state == 'rejected' %}
Feedback: {{ rejection_feedback }}
{% endif %}

{% if new_state == 'submitted' %}
Your proposal has been successfully submitted and will be reviewed according to the review process for this call. You will receive further notifications as your proposal progresses through the review process.
{% endif %}

{% if new_state == 'in_review' %}
Your proposal is now under review. Reviewers will evaluate your proposal based on the criteria specified in the call. This process may take {{ review_period }} days according to the round's review period.
{% endif %}

{% if new_state == 'accepted' %}
Congratulations! Your proposal has been accepted. Resources have been allocated based on your request and a new project has been created. You can access your project by clicking the link below.
{% endif %}

{% if new_state == 'rejected' %}
We regret to inform you that your proposal has not been accepted at this time. Please review any feedback provided above. You may have the opportunity to submit a revised proposal in future rounds.
{% endif %}

View Proposal: {{ proposal_url }}
{% if new_state == 'accepted' and project_url %}
View Project: {{ project_url }}
{% endif %}

This is an automated message from the {{ site_name }}. Please do not reply to this email.

new_review_submitted_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<html>
<head>
    <meta charset="UTF-8">
    <title>Review Submitted</title>
</head>
<body>
    <p>Dear call manager,</p>

    <p>A review has been submitted for proposal "{{ proposal_name }}" in call "{{ call_name }}".</p>

    <p>
        <strong>Review summary:</strong><br>
        - Reviewer: {{ reviewer_name }}<br>
        - Submission date: {{ review_date }}<br>
        - Score: {{ score }}/{{ max_score }}
    </p>

    <p>
        <strong>Review Progress:</strong><br>
        - Submitted reviews: {{ submitted_reviews }}<br>
        - Pending reviews: {{ pending_reviews }}<br>
        - Rejected reviews: {{ rejected_reviews }}<br>
    </p>

    <p>
        You can view the full review details at:<br>
        <a href="{{ review_url }}">{{ review_url }}</a>
    </p>

    <p>
        This is an automated message from the {{ site_name }}. Please do not reply to this email.
    </p>
</body>
</html>

new_proposal_submitted_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<html>
<head>
    <meta charset="UTF-8">
</head>
<body>
    <p>Dear call manager,</p>

    <p>A new proposal has been submitted to the call "{{ call_name }}".</p>

    <p>
        <strong>Proposal details:</strong><br>
        - Name: {{ proposal_name }}<br>
        - Submitted by: {{ proposal_creator_name }}<br>
        - Submission date: {{ submission_date }}<br>
        - Round: {{ round_name }}
    </p>

    <p>
        You can review this proposal by visiting the following URL:<br>
        <a href="{{ proposal_url }}">{{ proposal_url }}</a>
    </p>

    <p>
        This is an automated message from the {{ site_name }}. Please do not reply to this email.
    </p>
</body>
</html>

proposal_state_changed_subject.txt (waldur_mastermind.proposal)

1
Proposal state update: {{ proposal_name }} - {{ new_state }}

proposal_decision_for_reviewer_subject.txt (waldur_mastermind.proposal)

1
Decision made: Proposal {{ proposal_state }} - {{ proposal_name }}

proposal_cancelled_subject.txt (waldur_mastermind.proposal)

1
Proposal canceled: {{ proposal_name }}

new_review_submitted_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
Dear call manager,

A review has been submitted for proposal "{{ proposal_name }}" in call "{{ call_name }}".

Review summary:
- Reviewer: {{ reviewer_name }}
- Submission date: {{ submission_date }}
- Score: {{ score }}/{{ max_score }}

Review Progress:
- Submitted reviews: {{ submitted_reviews }}
- Pending reviews: {{ pending_reviews }}
- Rejected reviews: {{ rejected_reviews }}

You can view the full review details at:
{{ review_url }}

This is an automated message from the {{ site_name }}. Please do not reply to this email.

requested_offering_decision_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
Dear call manager,

The provider has {{ decision }} the request to include offering "{{ offering_name }}" in call "{{ call_name }}".

Offering details:
- Offering: {{ offering_name }}
- Provider: {{ provider_name }}
- Decision Date: {{ decision_date }}
- State: {{ decision }}

{% if decision == "accepted" %}This offering is now available for selection in proposals submitted to this call.{% endif %}

{% if decision == "canceled" %}You may need to look for alternative offerings or contact the provider directly for more information about their decision.{% endif %}

You can view the call details and manage offerings by visiting:
{{ call_url }}

This is an automated message from {{ site_name }}. Please do not reply to this email.

review_assigned_subject.txt (waldur_mastermind.proposal)

1
New review assignment: {{ proposal_name }}

review_rejected_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<html>
<head>
    <meta charset="UTF-8">
    <title>Reviewer Assignment Rejected</title>
</head>
<body>
    <p>Dear call manager,</p>

    <p>A reviewer has rejected their assignment to review proposal "{{ proposal_name }}" in call "{{ call_name }}".</p>

    <p>
        <strong>Assignment details:</strong><br>
        - Reviewer: {{ reviewer_name }}<br>
        - Assigned date: {{ assign_date }}<br>
        - Rejected date: {{ rejection_date }}
    </p>

    <p>
        <strong style="color: #d9534f;">ACTION REQUIRED:</strong> Please assign a new reviewer to maintain the minimum required number of reviews for this proposal.
    </p>

    <p>
        <strong>Review Progress:</strong><br>
        - Submitted reviews: {{ submitted_reviews }}<br>
        - Pending reviews: {{ pending_reviews }}<br>
        - Rejected reviews: {{ rejected_reviews }}<br>
    </p>

    <p>
        You can assign a new reviewer by visiting:<br>
        <a href="{{ create_review_link }}">{{ create_review_link }}</a>
    </p>

    <p>
        This is an automated message from the {{ site_name }}. Please do not reply to this email.
    </p>
</body>
</html>

review_assigned_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
Dear {{ reviewer_name }},

You have been assigned to review a proposal in call "{{ call_name }}".

Proposal details:
- Proposal name: {{ proposal_name }}
- Submitted by: {{ proposal_creator_name }}
- Date submitted: {{ submission_date }}
- Review deadline: {{ review_deadline }}

Please log in to the platform to review the proposal. You can accept or reject this review assignment by visiting:

{{ link_to_reviews_list }}

If you accept this assignment, you'll be able to access the full proposal content and submit your review.

This is an automated message from {{ site_name }}. Please do not reply to this email.

requested_offering_decision_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<html>
<head>
    <meta charset="UTF-8">
    <title>Offering request {{ decision }}</title>
</head>
<body>
    <p>Dear call manager,</p>

    <p>The provider has <strong>{{ decision }}</strong> the request to include offering "<strong>{{ offering_name }}</strong>" in call "<strong>{{ call_name }}</strong>".</p>

    <p><strong>Offering details:</strong></p>
    <ul>
        <li><strong>Offering:</strong> {{ offering_name }}</li>
        <li><strong>Provider:</strong> {{ provider_name }}</li>
        <li><strong>Decision Date:</strong> {{ decision_date }}</li>
        <li><strong>State:</strong> {{ decision }}</li>
    </ul>

    {% if decision == "accepted" %}
    <p>This offering is now available for selection in proposals submitted to this call.</p>
    {% endif %}

    {% if decision == "canceled" %}
    <p>You may need to look for alternative offerings or contact the provider directly for more information about their decision.</p>
    {% endif %}

    <p>You can view the call details and manage offerings by visiting:<br>
    <a href="{{ call_url }}">{{ call_url }}</a></p>

    <p><em>This is an automated message from {{ site_name }}. Please do not reply to this email.</em></p>
</body>
</html>

new_proposal_submitted_subject.txt (waldur_mastermind.proposal)

1
New proposal submitted: {{ proposal_name }}

proposal_cancelled_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<html>
<head>
    <meta charset="UTF-8">
    <title>Proposal Canceled</title>
</head>
<body>
    <p>Dear {{ proposal_creator_name }},</p>

    <p>Your proposal "{{ proposal_name }}" in call "{{ call_name }}" has been canceled.</p>

    <p>
        <strong>Cancellation details:</strong><br>
        - Proposal: {{ proposal_name }}<br>
        - Cancelation date: {{ cancellation_date }}<br>
        - Reason for cancellation: Round closure/The submission deadline has passed and the proposal was not finalized
    </p>

    <p>All draft proposals are automatically canceled when a round closes. This ensures that only fully submitted proposals proceed to the review stage.</p>

    <p>
        You can still view your proposal by visiting:<br>
        <a href="{{ proposal_url }}">{{ proposal_url }}</a>
    </p>

    <p>If you would like to resubmit your proposal, please check for upcoming rounds in this call or other relevant calls.</p>

    <p>
        This is an automated message from the {{ site_name }}. Please do not reply to this email.
    </p>
</body>
</html>

new_proposal_submitted_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
Dear call manager,

A new proposal has been submitted to the call "{{ call_name }}".

Proposal details:
- Name: {{ proposal_name }}
- Submitted by: {{ proposal_creator_name }}
- Submission date: {{ submission_date }}
- Round: {{ round_name }}

You can review this proposal by visiting the following URL:
{{ proposal_url }}

This is an automated message from the {{ site_name }}. Please do not reply to this email.

review_rejected_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
Dear call manager,

A reviewer has rejected their assignment to review proposal "{{ proposal_name }}" in call "{{ call_name }}".

Assignment details:
- Reviewer: {{ reviewer_name }}
- Assigned date: {{ assign_date }}
- Rejected date: {{ rejection_date }}

ACTION REQUIRED: Please assign a new reviewer to maintain the minimum required number of reviews for this proposal.

Review Progress:
- Submitted reviews: {{ submitted_reviews }}
- Pending reviews: {{ pending_reviews }}
- Rejected reviews: {{ rejected_reviews }}

You can assign a new reviewer by visiting:
{{ create_review_link }}

This is an automated message from the {{ site_name }}. Please do not reply to this email.

proposal_state_changed_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<html>
<head>
    <meta charset="UTF-8">
    <title>Proposal Status Update</title>
    <style>
        body {
            color: #333;
            max-width: 600px;
            margin: 0 auto;
            padding: 20px;
        }
        .header {
            margin-bottom: 20px;
        }
        .state-change {
            background-color: #f9f9f9;
            padding: 15px;
            border-radius: 5px;
            margin-bottom: 20px;
        }
        .message-box {
            padding: 15px;
            margin: 15px 0;
        }
        .footer {
            margin-top: 30px;
            color: #777;
            border-top: 1px solid #eee;
            padding-top: 10px;
        }
    </style>
</head>
<body>
    <div class="header">
        <p>Dear {{ proposal_creator_name }},</p>
        <p>The state of your proposal "<strong>{{ proposal_name }}</strong>" in call "<strong>{{ call_name }}</strong>" has been updated.</p>
    </div>

    <div class="state-change">
        <h3>State change:</h3>
        <ul>
            <li><strong>Previous state:</strong> {{ previous_state }}</li>
            <li><strong>New state:</strong> {{ new_state }}</li>
            <li><strong>Updated on:</strong> {{ update_date }}</li>
        </ul>

        {% if new_state == 'accepted' %}
        <ul>
            <li><strong>Project created:</strong> {{ project_name }}</li>
            <li><strong>Allocation start date:</strong> {{ allocation_date }}</li>
            <li><strong>Duration:</strong> {{ duration }} days</li>
        </ul>
        <div>
            <h4>Allocated resources:</h4>
            {% for resource in allocated_resources %}
            <div>
                <strong>{{ forloop.counter }}.</strong> {{ resource.name }} - {{ resource.provider_name }} - {{ resource.plan_name }} - Provisioned
            </div>
            {% empty %}
            <p><em>No resources allocated yet.</em></p>
            {% endfor %}
        </div>
        {% endif %}

        {% if new_state == 'rejected' %}
        <p><strong>Feedback:</strong> {{ rejection_feedback }}</p>
        {% endif %}
    </div>

    <div class="message-box">
        {% if new_state == 'submitted' %}
        <p>Your proposal has been successfully submitted and will be reviewed according to the review process for this call. You will receive further notifications as your proposal progresses through the review process.</p>
        {% endif %}

        {% if new_state == 'in_review' %}
        <p>Your proposal is now under review. Reviewers will evaluate your proposal based on the criteria specified in the call. This process may take {{ review_period }} days according to the round's review period.</p>
        {% endif %}

        {% if new_state == 'accepted' %}
        <p>Congratulations! Your proposal has been accepted. Resources have been allocated based on your request and a new project has been created. You can access your project by clicking the link below.</p>
        {% endif %}

        {% if new_state == 'rejected' %}
        <p>We regret to inform you that your proposal has not been accepted at this time. Please review any feedback provided above. You may have the opportunity to submit a revised proposal in future rounds.</p>
        {% endif %}
    </div>

    <a href="{{ proposal_url }}">View Proposal</a>
    <br>
    {% if new_state == 'accepted' and project_url %}
    <a href="{{ project_url }}">View Project</a>
    {% endif %}

    <div class="footer">
        <p>This is an automated message from the {{ site_name }}. Please do not reply to this email.</p>
    </div>
</body>
</html>

new_review_submitted_subject.txt (waldur_mastermind.proposal)

1
Review submitted for proposal: {{ proposal_name }}

requested_offering_decision_subject.txt (waldur_mastermind.proposal)

1
Offering request {{ decision }}: {{ offering_name }}

proposal_decision_for_reviewer_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<html>
<head>
    <meta charset="UTF-8">
    <title>Proposal {{ proposal_state }}</title>
</head>
<body>
    <p>Dear {{ reviewer_name }},</p>

    <p>A decision has been made on the proposal "<strong>{{ proposal_name }}</strong>" in call "<strong>{{ call_name }}</strong>" that you reviewed.</p>

    <p><strong>Decision details:</strong></p>
    <ul>
        <li><strong>Proposal:</strong> {{ proposal_name }}</li>
        <li><strong>Decision:</strong> {{ proposal_state }}</li>
        <li><strong>Decision date:</strong> {{ decision_date }}</li>
    </ul>

    {% if proposal_state == "rejected" and rejection_reason %}
    <p><strong>Reason:</strong> {{ rejection_reason }}</p>
    {% endif %}

    <p>Thank you for your valuable contribution to the review process. Your expert assessment helped inform this decision.</p>

    <p>View proposal: <a href="{{ proposal_url }}">{{ proposal_url }}</a></p>

    <p><em>This is an automated message from {{ site_name }}. Please do not reply to this email.</em></p>
</body>
</html>

review_assigned_message.html (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<html>
<head>
    <meta charset="UTF-8">
</head>
<body>
<p>Dear {{ reviewer_name }},</p>

<p>You have been assigned to review a proposal in call "<strong>{{ call_name }}</strong>".</p>

<p><strong>Proposal details:</strong></p>
<ul>
    <li><strong>Proposal name:</strong> {{ proposal_name }}</li>
    <li><strong>Submitted by:</strong> {{ proposal_creator_name }}</li>
    <li><strong>Date submitted:</strong> {{ submission_date }}</li>
    <li><strong>Review deadline:</strong> {{ review_deadline }}</li>
</ul>

<p>Please log in to the platform to review the proposal. You can accept or reject this review assignment by visiting:</p>

<a href="{{ link_to_reviews_list }}">{{ link_to_reviews_list }}</a>

<p>If you accept this assignment, you'll be able to access the full proposal content and submit your review.</p>

<p><em>This is an automated message from {{ site_name }}. Please do not reply to this email.</em></p>
</body>
</html>

proposal_cancelled_message.txt (waldur_mastermind.proposal)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
Dear {{ proposal_creator_name }},

Your proposal "{{ proposal_name }}" in call "{{ call_name }}" has been canceled.

Cancellation details:
- Proposal: {{ proposal_name }}
- Cancellation date: {{ cancellation_date }}
- Reason for cancellation: Round closure/The submission deadline has passed and the proposal was not finalized

All draft proposals are automatically canceled when a round closes. This ensures that only fully submitted proposals proceed to the review stage.

You can still view your proposal by visiting:
{{ proposal_url }}

If you would like to resubmit your proposal, please check for upcoming rounds in this call or other relevant calls.

This is an automated message from the {{ site_name }}. Please do not reply to this email.

waldur_mastermind.support

notification_comment_updated.txt (waldur_mastermind.support)

1
2
3
Hello!

The comment has been updated. Please go to {{issue_url}} to see it.

notification_issue_feedback.txt (waldur_mastermind.support)

1
2
3
4
5
6
7
8
9
Hello, {{issue.caller.full_name}}!

We would like to hear your feedback regarding your recent experience with support for {{issue_url}}.

Click on the evaluations below to provide the feedback.

{% for link in feedback_links%}
    {{link.label}}: {{link.link}}
{% endfor %}

description.txt (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{{issue.description}}

Additional Info:
{% if issue.customer %}- Organization: {{issue.customer.name}}{% endif %}
{% if issue.project %}- Project: {{issue.project.name}}{% endif %}
{% if issue.resource %}
    {% if issue.resource.service_settings %}
        {% if issue.resource.service_settings.type %}- Service type: {{issue.resource.service_settings.type}}{% endif %}
        - Offering name: {{ issue.resource.service_settings.name }}
        - Offering provided by: {{ issue.resource.service_settings.customer.name }}
    {% endif %}
    - Affected resource: {{issue.resource}}
    - Backend ID: {{issue.resource.backend_id}}
{% endif %}
- Site name: {{ settings.WALDUR_CORE.SITE_NAME }}
- Site URL: {{ config.HOMEPORT_URL }}

summary.txt (waldur_mastermind.support)

1
{% if issue.customer.abbreviation %}{{issue.customer.abbreviation}}: {% endif %}{{issue.summary}}

notification_issue_updated_subject.txt (waldur_mastermind.support)

1
Updated issue: {{issue.key}} {{issue.summary}}

notification_comment_added.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The issue you have created ({{ issue.key }}) has a new comment</title>
</head>
<body>
<p>
    {% if is_system_comment %}
        Added a new comment.
    {% else %}
        {{ comment.author.name }} added a new comment.
    {% endif %}
</p>
<p>
    <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
</p>
<div>
    {{ description|safe }}
</div>
</body>
</html>

notification_issue_updated.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The issue you have ({{ issue.key }}) has been updated</title>
</head>
<body>
<p>
    Hello!
</p>
{% if changed.status %}
<p>
    Status has been changed from <strong>{{ changed.status }}</strong> to <strong>{{ issue.status }}</strong>.
</p>
{% endif %}
{% if old_description %}
<p>
    Description has been changed from <strong>{{ old_description|safe }}</strong> to <strong>{{ description|safe }}</strong>.
</p>
{% endif %}
{% if changed.summary %}
<p>
    Summary has been changed from <strong>{{ changed.summary }}</strong> to <strong>{{ issue.summary }}</strong>.
</p>
{% endif %}
{% if changed.priority %}
<p>
    Priority has been changed from <strong>{{ changed.priority }}</strong> to <strong>{{ issue.priority }}</strong>.
</p>
{% endif %}
<p>
    Please visit <a href="{{ issue_url }}">{{ site_name }}</a> to find out more details.
</p>
</body>
</html>

notification_comment_added.txt (waldur_mastermind.support)

1
2
3
Hello!

The issue you have created has a new comment. Please go to {{issue_url}} to see it.

notification_issue_feedback_subject.txt (waldur_mastermind.support)

1
Please share your feedback: {{issue.key}} {{issue.summary}}

notification_issue_feedback.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The issue you have ({{ issue.key }}) has been updated</title>

    <style>
        * {
          font-family: sans-serif;
        }
        .rating {
          unicode-bidi: bidi-override;
          direction: rtl;
          width: 500px;
        }
        .rating > a {
          display: inline-block;
          position: relative;
          width: 1.1em;
          text-decoration: none;
          font-size: xx-large;
          color: rgba(180, 179, 178, 1);
        }
        .rating > a:hover:before,
        .rating > a:hover ~ a:before {
           content: "\2605";
           position: absolute;
           color: rgba(224, 194, 75, 1);
        }
    </style>

</head>
<body>
<p>Hello, {{issue.caller.full_name}}!</p>
<p>We would like to hear your feedback regarding your recent experience with support for
    <a href='{{issue_url}}'>{{ issue.summary }}</a>.
</p>
<p>Click the stars below to provide your feedback:</p>
<div class="rating">
    {% for link in feedback_links reversed %}
        <a href='{{link.link}}'>☆</a>
    {% endfor %}
</div>
</body>
</html>

notification_comment_added_subject.txt (waldur_mastermind.support)

1
The issue ({{ issue.key }}) you have created has a new comment

notification_issue_updated.txt (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
Hello!

The issue you have has been updated.

{% if changed.status %}
Status has been changed from {{ changed.status }} to {{ issue.status }}.
{% endif %}
{% if changed.description %}
Description has been changed from {{ changed.description }} to {{ issue.description }}.
{% endif %}
{% if changed.summary %}
Summary has been changed from {{ changed.summary }} to {{ issue.summary }}.
{% endif %}
{% if changed.priority %}
Priority has been changed from {{ changed.priority }} to {{ issue.priority }}.
{% endif %}

Please go to {{issue_url}} to see it.

notification_comment_updated.html (waldur_mastermind.support)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>The comment has been updated ({{ issue.key }})</title>
</head>
<body>
<p>
    {{ comment.author.name }} updated comment.
</p>
<p>
    <a href="{{ issue_url }}">[{{ issue.key }}] {{ issue.summary }}</a>
</p>
<p>
    Old comment:
</p>
<p>
    {{ old_description|safe }}
</p>
<p>
    New comment:
</p>
<p>
    {{ description|safe }}
</p>
</body>
</html>

notification_comment_updated_subject.txt (waldur_mastermind.support)

1
Issue {{ issue.key }}. The comment has been updated

Ended: Mastermind configuration

Azure

Warning

Documentation is in progress. Plugin development is in progress.

Setting up Tenant

https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant

Setting up a Client

https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app

Add permissions

Make sure that client is able to perform operations on the different resources.

https://stackoverflow.com/questions/42134892/the-client-with-object-id-does-not-have-authorization-to-perform-action-microso

Collecting Azure credentials for Waldur

You need to provide following Azure credentials to Waldur: subscription ID, tenant ID, client ID and client secret.

Get Subscription ID

  • Login into your Azure account.
  • Select Subscriptions in the left sidebar.
  • Select whichever subscription is needed.
  • Click on Overview.
  • Copy the Subscription ID.

Get Tenant ID

  • Login into your Azure account.
  • Select Azure Active Directory in the left sidebar.
  • Click Properties.
  • Copy the Directory ID.

Get Client ID

  • Login into your Azure account.
  • Select Azure Active Directory in the left sidebar.
  • Click Enterprise applications.
  • Click All applications.
  • Select the application which you have created.
  • Click Properties.
  • Copy the Application ID.

Get Client secret

  • Login into your Azure account.
  • Select Azure Active Directory in the left sidebar.
  • Click App registrations.
  • Select the application which you have created.
  • Click on All settings.
  • Click on Keys.
  • Type Key description and select the Duration.
  • Click save.
  • Copy and store the key value. You won’t be able to retrieve it after you leave this page.

See also: How to: Use the portal to create an Azure AD application and service principal that can access resources

Custom scripts

Custom scripts is a type of plugin that allows defining custom scripts that are executed at different lifecycle events of the resource. The scripts are executed in one time containers. Depending on the deployment type, it can be either a docker container for docker-compose-based, or Kubernetes Jobs for Helm-based deployments.

The following lifecycle events are supported:

  • Creation;
  • Update - change of plans or limits;
  • Termination;
  • Regular updates - executed once per hour, aka pull script.

Script output format

It is possible to control certain aspects of resource management with outputs of the custom scripts. Below we list currently supported conventions and their impact.

Creation script

You can set the the backend_id of the created resource by passing a single string as the last line of the output.

1
2
3
4
5
# for python-based scripts
import uuid

UUID = uuid.uuid4()
print(UUID)

If you want to save additional metadata, then last line of output should consist of 2 space separated strings:

  • ID of the created resource that will be saved as backend_id;
  • Base64 encoded metadata object.
1
2
3
4
5
6
7
# for python-based scripts
import base64
import uuid

UUID = uuid.uuid4()
metadata = {"backend_metadata": {"cpu": 1}}
print(UUID + ' ' + base64.b64encode(metadata))

Regular updates script

The script for regular updates allows to update usage information as well as provide updates of reporting. In all cases the last line should include a base64-encoded string containing a dictionary with keywords:

  • "usages" for usage reporting;
  • "report" for updating resource report.

Examples of Python-based scripts are:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# for python-based scripts
import base64

info = {
  "usages": [
    {
      "type": "cpu",
      "amount": 10
    },
  ]
}

info_json = json.dumps(info)

info_json_encoded = info_json.encode("utf-8")

print(base64.b64encode(info_json_encoded).decode("utf-8"))

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# for python-based scripts
import base64

info = {
  "report": [
    {
      "header": "header",
      "body": "body"
    },
  ]
}

info_json = json.dumps(info)

info_json_encoded = info_json.encode("utf-8")

print(base64.b64encode(info_json_encoded).decode("utf-8"))

Example scripts

Each of the scripts below require access to remote Waldur instance. Credentials for this passed as environment variables to the scripts with keys:

  • WALDUR_API_URL - URL of remote Waldur API including /api/ path, example: http://localhost/api/
  • WALDUR_API_TOKEN - token for a remote user with permissions of service provider owner

Script for resource creation

In the remote Waldur site, customer and offering should be pre-created for successful resource creation. Please, add the necessary variables to the local offering's environment:

  • REMOTE_CUSTOMER_NAME - name of the pre-created customer in the remote Waldur
  • REMOTE_OFFERING_UUID - UUID of the remote offering for creation of the remote resource
  • PROJECT_NAME - name of the remote project to be created
  • PI_EMAILS - optional comma-separated list of emails receiving invitations to the project after creation of the remote resource
  • REMOTE_PROJECT_CREDIT_AMOUNT - optional amount of credit applied to the remote project
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
from os import environ
from time import sleep
import uuid
import json
from waldur_api_client import AuthenticatedClient
from waldur_api_client.api.customers import customers_list
from waldur_api_client.api.projects import projects_list, projects_create
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_retrieve
from waldur_api_client.api.marketplace_resources import marketplace_resources_create
from waldur_api_client.api.marketplace_orders import marketplace_orders_retrieve,marketplace_orders_create, marketplace_orders_approve_by_provider
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_retrieve
from waldur_api_client.api.project_credits import project_credits_list, project_credits_create
from waldur_api_client.api.roles import roles_list
from waldur_api_client.api.project_invitations import project_invitations_create
from waldur_api_client.models import ProjectCreditRequest, OrderCreateRequest, InvitationRequest, RequestTypes, OrderState
from waldur_api_client.api.user_invitations import user_invitations_create
from os import environ
from time import sleep


client = AuthenticatedClient(
    base_url=environ["WALDUR_API_URL"],
    token=environ["WALDUR_API_TOKEN"],
)

CUSTOMER_NAME = environ["REMOTE_CUSTOMER_NAME"]
OFFERING_UUID = environ["REMOTE_OFFERING_UUID"]
PROJECT_NAME = environ["REMOTE_PROJECT_NAME"]
PI_EMAILS = environ.get("PI_EMAILS")
RESOURCE_LIMITS = environ["LIMITS"]
PROJECT_CREDIT_AMOUNT = environ.get("REMOTE_PROJECT_CREDIT_AMOUNT")


def get_or_create_project():
    print(f"Listing customers with name_exact: {CUSTOMER_NAME}")
    existing_customers = customers_list.sync(client=client, name_exact=CUSTOMER_NAME)
    if not existing_customers:
        print(f"Customer with name {CUSTOMER_NAME} not found")
        exit(1)
    else:
        print(f"Customer with name {CUSTOMER_NAME} exists")
        customer = existing_customers[0]

    customer_uuid = customer.uuid

    print(f"Listing projects with name_exact: {PROJECT_NAME}")
    existing_projects = projects_list.sync(client=client, name_exact=PROJECT_NAME)
    if not existing_projects:
        print(f"Project with name {PROJECT_NAME} not found, creating it")
        return projects_create.sync(client=client, customer_uuid=customer_uuid, name=PROJECT_NAME)
    else:
        print(f"Project with name {PROJECT_NAME} exists")
        return existing_projects[0]


def get_or_create_project_credits():
    print(f"Listing project credits for project_uuid: {project_uuid}")
    project_credits = project_credits_list.sync(client=client, project_uuid=project_uuid)
    if not project_credits:
        print(f"Project credit for project_uuid {project_uuid} not found, creating it with amount {PROJECT_CREDIT_AMOUNT}")
        return project_credits_create.sync(
            client=client,
            body=ProjectCreditRequest(
                project=project_uuid,
                value=PROJECT_CREDIT_AMOUNT
            )
        )
    else:
        print(f"Project credit for project_uuid {project_uuid} exists")
        return project_credits[0]


def invite_PIs():
    print("Listing active roles")
    roles = roles_list.sync(client=client, is_active=True)
    print('Looking up role with name "PROJECT.MANAGER"')
    project_manager_role = next(role for role in roles if role.name == "PROJECT.MANAGER")
    project_manager_role_uuid = project_manager_role.uuid

    print("Inviting PIs")
    for pi_email in PI_EMAILS.split(","):
        if not pi_email:
            continue
        print(f"Creating project invitation for email: {pi_email}")
        user_invitations_create.sync(
            client=client,
            body=InvitationRequest(
                role=project_manager_role_uuid,
                scope=project_uuid,
                email=pi_email
            )
        )

def create_resource(resource_name):
    print(f"Fetching marketplace provider offerings with UUID: {OFFERING_UUID}")
    offering = marketplace_provider_offerings_retrieve.sync(client=client, uuid=OFFERING_UUID)
    print("Getting first plan UUID from offering")
    plan_uuid = offering.plans[0].uuid
    resource_attributes = {
        "name": resource_name,
    }
    resource_limits = json.loads(RESOURCE_LIMITS)

    print("Submitting order")
    order_request = OrderCreateRequest(
        offering=offering_url,
        project=project_url,
        plan=str(plan_uuid),
        attributes=resource_attributes,
        limits=resource_limits,
        type_=RequestTypes.CREATE,
        accepting_terms_of_service=True
    )

    # Submit order
    order = marketplace_orders_create.sync(client=client, body=order_request)
    print(f"Order created successfully. Order UUID: {order.uuid}")

    print("Fetching order")
    create_order_uuid = order.uuid
    resource_uuid = order.marketplace_resource_uuid
    order = marketplace_orders_retrieve.sync(client=client, uuid=create_order_uuid)

    print("Approving order")
    marketplace_orders_approve_by_provider.sync_detailed(client=client, uuid=order.uuid)
    order = marketplace_orders_retrieve.sync(client=client, uuid=create_order_uuid)

    max_retries = 10
    retry_count = 0
    print("Waiting for order to be done")
    while order.state != OrderState.DONE and retry_count < max_retries:
        print(f"Order state: {order.state}")
        order = marketplace_orders_retrieve.sync(client=client, uuid=order.uuid)
        sleep(5)
        retry_count += 1

    if order.state != OrderState.DONE:
        print(f"Order execution timed out, state is {order.state}")
        exit(1)

    print("Order is done")

    print(f"Fetching marketplace provider resource with UUID: {resource_uuid}")
    resource = marketplace_provider_resources_retrieve.sync(client=client, uuid=resource_uuid)

    print(f'Resource state is {resource.state}')
    return resource

unique_id = uuid.uuid4().hex
resource_name = f"portal-test-{unique_id}"

project = get_or_create_project()
project_uuid = project.uuid

if PROJECT_CREDIT_AMOUNT is not None:
    get_or_create_project_credits()

resource = create_resource(resource_name)

if PI_EMAILS is not None:
    invite_PIs()

print("Execution finished")

print(resource.uuid)

Script for usage pull

This script periodically pulls usage data of the remote resource and saves it locally.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
from waldur_api_client import AuthenticatedClient
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_list
from os import environ
import datetime
import base64
import json
from uuid import UUID

client = AuthenticatedClient(
    base_url=environ["WALDUR_API_URL"],
    token=environ["WALDUR_API_TOKEN"],
)
RESOURCE_UUID = UUID(environ["RESOURCE_BACKEND_ID"])

current_date = datetime.datetime.now()
month_start = datetime.datetime(day=1, month=current_date.month, year=current_date.year).date()

print(f"Fetching resource usages from {month_start.isoformat()}")
resource_usages = marketplace_component_usages_list.sync(
    client=client,
    resource_uuid=RESOURCE_UUID,
    date_after=month_start,
)

usages_data = []

for usage in resource_usages:
    usages_data.append(
        {
            "type": usage.type,
            "amount": usage.usage,
        }
    )

output = {
    "usages": usages_data,
}

output_json = json.dumps(output)
output_json_encoded = output_json.encode("utf-8")

print(base64.b64encode(output_json_encoded).decode("utf-8"))

Script for resource termination

This script terminates the remote resource.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
from waldur_api_client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_terminate
from waldur_api_client.api.marketplace_orders import marketplace_orders_approve_by_provider, marketplace_orders_retrieve
from waldur_api_client.models import OrderState
from os import environ
from time import sleep
from uuid import UUID

# Initialize the client
client = AuthenticatedClient(
    base_url=environ["WALDUR_API_URL"],
    token=environ["WALDUR_API_TOKEN"],
)

# Get the resource UUID from environment
RESOURCE_UUID = UUID(environ["RESOURCE_BACKEND_ID"])

print('Creating resource termination order')

# Create termination order
order_uuid = marketplace_resources_terminate.sync(
    uuid=RESOURCE_UUID,
    client=client,
    body={}  # Empty body for termination request
)

print('Approving the order')
# Approve the order
marketplace_orders_approve_by_provider.sync_detailed(
    uuid=order_uuid,
    client=client
)

# Wait for order completion
max_retries = 10
retry_count = 0
print("Waiting for order to be done")
while retry_count < max_retries:
    order = marketplace_orders_retrieve.sync(
        uuid=order_uuid,
        client=client
    )
    print(f"Order state: {order.state}")
    if order.state == OrderState.DONE:
        break
    sleep(5)
    retry_count += 1

if retry_count >= max_retries:
    print(f"Order execution timed out, state is {order.state}")
    exit(1)
print('Order is done, resource is being terminated')

MOAB

MOAB is a scheduling engine for HPC centers from Adaptive Computing.

Waldur implementation of support for MOAB is done via the Waldur site agent.

OpenStack (Tenant)

Requirements for OpenStack (Tenant)

OpenStack versions tested:

  • Queens
  • Rocky
  • Stein
  • Train
  • Ussuri
  • Victoria
  • Wallaby
  • Xena
  • Yoga
  • Zed
  • Antelope

In order to integrate an OpenStack-based cloud as a shared provider, the following data is required:

  • URL of Keystone's public endpoint (v3).
  • Access to public interfaces of Keystone, Nova, Cinder, Neutron and Glance should be opened to Waldur MasterMind server.
  • Admin credentials (username/password) as well as domain name (in case non-default domain is used).
  • External network UUID - the network will be by default connected to all created OpenStack Projects (Tenants).

Advanced settings

It's possible to override some settings for OpenStack in MasterMind admin interface. To do that, please go to Waldur MasterMind Admin interface with a staff account.

Go to Structure → Shared provider settings and select the one you want to update.

Define specific customisation options. To add an option select append on item block under the object tree. Most typical are:

  • external_network_id – external network to connect to when creating a VPC from this provider.
  • access_url - a URL to access OpenStack Horizon dashboard from a public network. Typically a reverse proxy URL in production deployments.
  • flavor_exclude_regex - flavors matching this regex expression will not be pulled from the backend.
  • dns_nameservers - default value for new subnets DNS name servers. Should be defined as list.
  • create_ha_routers - create highly available Neutron routers when creating Tenants.

Support for Organization specific OpenStack networks

You can provide specific external network for all OpenStack Tenants created by Organiztion by providing external network UUIDs in Organization configuration in Waldur Mastermind admin portal.

Organization specific OS networks

Remote Offering

Warning

Documentation is in progress. Plugin development is in progress.

Introduction

It is possible to import into a Waldur offerings from a remote Waldur.

Pre-requisites

  • An organization in the remote Waldur, which will contain requests and projects from the local Waldur.
  • Account with owner role that will be used for integration.
  • Access to APIs of remote Waldur.

High level process

  • In local Waldur, make sure that you have a service provider organization available.
  • Click on "Import offering".
  • Input remote Waldur API and authentication token.
  • Select the remote organization and offering to be imported.
  • Review and activate the offering.

eduTEAMS account SYNC

In case both local and remote Waldurs are relying on a common set of identities from eduTEAMS, it is possible to configure synchronisation of the identities as well, i.e. when a resource is provisioned in a remote Waldur, local accounts from organization and project are pushed and mapped to the remote project.

Note

For this to work, remote Waldur must be integrated with eduTEAMS registry and integration user must have identity_manager role.

Remote offering actions

Remote offering actions are available in the integration section of the offering edit page.

Remote Offering Actions

SLURM provider

SLURM plugin enables sharing of access to a SLURM cluster. SLURM is a scheduling system used typically for managing High-performance clusters. Waldur allows to share access by creating Slurm accounts and managing permission rights of users.

Important note

This page describes the legacy marketplace plugin for SLURM. For the new SLURM plugin, we recommend to check this page

Configure Waldur SLURM plugin

By default, Waldur creates a hierarchical account structure in SLURM, where:

  • Organization gets an account under a default account, defined when configuring SLURM service offering;
  • Each project is created as a an allocation, which is a child of organization's account.
  • Each resource created in Waldur (aka SLURM Allocation) gets its own SLURM account with project account as a parent.

These accounts get standard prefixes along with unique values and user provided input. It is possible to customize prefixes in Waldur configuration. Check WALDUR_SLURM variables in Waldur configuration guide.

Add SLURM provider

To add SLURM as a provider to Waldur, you will need the following information:

  • SSH host address to a node, from where SLURM commands could be executed.
  • Username that has Slurm operator role. Operator is needed as Waldur dynamically creates accounts based on user's choice of FreeIPA account.
  • Waldur public key must be added as authorized_key for the operator's username.
  • Slurm login node must be configured to authenticate users coming from FreeIPA connected to Waldur.

SLURM auto-provisioning hooks

It is possible to streamline creation of SLURM allocations for new users based on affiliation of a user profile. Configuration settings are described in Waldur configuration guide under WALDUR_HPC settings.

The logic is as follows:

  • Once a user is created (e.g. via eduGAIN login), user's affiliation and email are checked to see if user belongs to internal or external organization.
  • If so, a project is created for the user in a corresponding organization.
  • For users belonging to internal organization, SLURM request is pre-filled and created using account limits of internal organizations.
  • For users belonging to external organization, SLURM request is pre-filled only - it would require a manual confirmation from the organization owner of the external organization to be provisioned. Default limits of SLURM apply.

Configure SLURM cluster

Waldur might work out of the box with most of the reasonably modern deployments of SLURM, which have accounting enabled and limits enforced.

Please refer to SLURM documentation for details:

We provide a snapshot of instructions for the convenience of the reader.

Add SLURM cluster

SLURM accounting plugin assumes that at least one cluster is configured. For example:

1
sacctmgr add cluster linux

Enforce SLURM accounting limits

In order to enforce limits set on associations and QoS, please modify slurm.conf:

1
AccountingStorageEnforce=limits

Please note, that when AccountingStorageEnforce is changed, a restart of the slurmctld daemon is required (not just a scontrol reconfig):

1
systemctl restart slurmctld

Enable SLURM Multi Priority plugin

In order to enable ordering for the queue of jobs waiting to be scheduled, please modify slurm.conf:

1
PriorityType=priority/multifactor

When slurm.conf is changed, you should reload configuration:

1
scontrol reconfig

Waldur Site Agent

Project for Waldur integration with a service provider's site. The main purpose of the agent is data syncronization between Waldur and a service backend (for example SLURM or MOAB cluster). The agent uses order information from Waldur to manage accounts in the site (backend) and accounting info from the site to update usage data in Waldur. For now, the agent supports only SLURM and MOAB clusters as a service backend.

Architecture

Agent is a stateless application, which is deployed on a machine with access to backend data. It supports 4 modes:

  • agent-order-process, which fetches ordering data from Waldur and updates a state of backend object correspondingly; (e.g. creates/updates/deletes SLURM accounts);
  • agent-report, which reports computing usage and limits info from the backend to Waldur (e.g. update of resource usages);
  • agent-membership-sync, which syncronizes membership info between Waldur and the backend (e.g. adds users to a SLURM allocation);
  • agent-event-process, which uses event-based approach to do the same as agent-order-process and agent-membership-sync; requires either MQTT- or STOMP-plugin as an event delivery system between Waldur and the agent.

Code-wise, the agent consists of the main python module called waldur-site-agent and set of plugins with implementation for different backends (for example, waldur-site-agent-slurm). The main module contains the configuration for running the application, shared utils and abstract classes for backends. A plugin should contain implementation of the abstract classes exposing them via entry-points in the respecting pyproject.toml file. Each plugin depends on the main module, while this module uses plugin classes via entry-points.

For detailed information about the plugin architecture, including diagrams, implementation details, and custom plugin development, see the Architecture Documentation.

Integration with Waldur

The agent uses a Python-based Waldur client communicating with Waldur backend via REST interface. Agent-order-process application pulls data of orders created in Waldur and creates/updates/removes backend resources based on this info. Agent-report fetches usage data pushes it to Waldur. Agent-membership-sync fetches associations from a backend and syncronizes it with remote ones. Agent-event-process manages Waldur orders and membership in event-based way.

Integration with the site

SLURM cluster

The agent relies on SLURM command-line utilities (e.g. sacct and sacctmgr) and should run on a headnode of the SLURM cluster.

MOAB cluster

The agent relies on MOAB command line utilities (e.g. mam-list-accounts and mam-create-account) and should run on a headnode of the MOAB cluster as a root user.

Agent configuration

The application supports the following CLI arguments:

  • -m, --mode - mode of agent; supported values: order_process, report, membership_sync and event_process; default is order_process.
  • -c, --config-file - path to the config file with provider settings.

Optional environment variables:

  • WALDUR_SITE_AGENT_ORDER_PROCESS_PERIOD_MINUTES - trigger period for order_process mode in minutes (default is 5);
  • WALDUR_SITE_AGENT_REPORT_PERIOD_MINUTES - trigger period for report mode in minutes (default is 30);
  • WALDUR_SITE_AGENT_MEMBERSHIP_SYNC_PERIOD_MINUTES - trigger period for membership_sync mode in minutes (default is 5).
  • SENTRY_ENVIRONMENT - name of the Sentry environment.

The main config source for the agent is waldur-site-agent-config.yaml file. Using it, the agent can serve multiple offerings and setup backend-related data, for example settings of computing components. File example and reference.

NB: for MOAB, the only acceptable backend component is deposit. All other specified components are ignored by the agent.

NB: The timezone setting is important when agent and Waldur are deployed in different timezones, this setting can be used to prevent billing period mismatches at month boundaries. Recommended: timezone: "UTC".

Deployment

A user can deploy 4 separate instances of the agent. The first one (called agent-order-process) fetches data from Waldur with further processing, the second one (called agent-report) sends usage data from the backend to Waldur the third one syncs membership information between Waldur and the backend (called agent-membership-sync) and the optional fourth one processes order and membership info in event-based way (agent-event-process). The last one covers the same functionality as the first two services, but uses event bus for integration with Waldur. All the instances must be configured with provider config file and CLI variables.

To deploy them, you need to setup and start the systemd services.

Note: only one of these service combinations is possible:

  1. agent-order-process, agent-membership-sync and agent-report
  2. agent-event-process and agent-report

Prerequisite: offering configuration in Waldur

SLURM and MOAB

Agents require a pre-created offering in Waldur. As a service provider owner, you should create a new offering in the marketplace:

  • Go to Service Provider section of the organization and open offering creation menu
  • Input a name, choose a category, select Waldur site agent from the drop-down list on the bottom and click Create button

offering-creation

  • Open the offering page, choose Edit tab, click Accounting section, choose Accounting plans from the drop-down list and create a plan: click Add plan and input the necessary details;

offering-plan

  • In the same page, click Integration section choose User management from the drop-down list and set the Service provider can create offering user option to Yes;

offering-user-management

  • Activate the offering using the big green button Activate.

Note: You will need to set the offering UUID in the agent config file. For this, you can copy the UUID from the Integration -> Credentials section on the same page:

offering-uuid

Setup

Firstly, install the waldur-site-agent module:

1
pip install waldur-site-agent

Secondly, create the provider config file and adjust the content for your needs.

1
2
3
4
5
sudo mkdir -p /etc/waldur

sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/examples/waldur-site-agent-config.yaml.example \
  -o /etc/waldur/waldur-site-agent-config.yaml

Please use the waldur_site_load_components command to load computing components into Waldur. This step is necessary for correct setup of the offering in Waldur.

1
waldur_site_load_components -c /etc/waldur/waldur-site-agent-config.yaml

Thirdly, put systemd unit and provider config files to the corresponding locations.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
# For agent-order-process
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-order-process/agent.service \
  -o /etc/systemd/system/waldur-agent-report.service

# For agent-report
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-report/agent.service \
  -o /etc/systemd/system/waldur-agent-report.service

# For agent-membership-sync
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-membership-sync/agent.service \
  -o /etc/systemd/system/waldur-agent-membership-sync.service

# For agent-event-process
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-event-process/agent.service \
  -o /etc/systemd/system/waldur-agent-event-process.service

After these preparation steps, run the following script to apply the changes.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
systemctl daemon-reload

systemctl start waldur-agent-order-process.service
systemctl enable waldur-agent-order-process.service # to start after reboot

systemctl start waldur-agent-report.service
systemctl enable waldur-agent-report.service

systemctl start waldur-agent-membership-sync.service
systemctl enable waldur-agent-membership-sync.service

systemctl start waldur-agent-event-process.service
systemctl enable waldur-agent-event-process.service # to start after reboot

Event-based processing

Each offering from the config file can have mqtt_enabled or stomp_enabled set to true or false (false by default). NB: only of them can be true

If this setting set to true, the offering is ignored by agent-order-process and agent-membership-sync, instead, the agent-event-process takes care of it.

Older systemd versions

If you want to deploy the agents on a machine with systemd revision older than 240, you should use files with legacy configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# For agent-order-process
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-order-process/agent-legacy.service \
  -o /etc/systemd/system/waldur-agent-order-process-legacy.service
# For agent-report
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-report/agent-legacy.service \
  -o /etc/systemd/system/waldur-agent-report-legacy.service
# For agent-membership-sync
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-membership-sync/agent-legacy.service \
  -o /etc/systemd/system/waldur-agent-membership-sync-legacy.service
# For agent-event-process
sudo curl -L \
https://raw.githubusercontent.com/waldur/waldur-site-agent/main/systemd-conf/agent-event-process/agent-legacy.service \
  -o /etc/systemd/system/waldur-agent-event-process-legacy.service

Custom backends

A user should explicitly set backend type for each agent process in an offering config. For this, a user should use the following settings in an offering item:

  • order_processing_backend - name of the backend from entrypoints to use for order processing;
  • membership_sync_backend - name of the backend from entrypoints to use for membership syncing;
  • reporting_backend - name of the backend from entrypoints to use for reporting.

If a setting is omitted, the agent doesn't start the respecting process.

For example, given the following config:

1
2
3
4
5
6
7
8
...
offerings:
  - name: "Example SLURM Offering"
    ...
    stomp_enabled: true
    order_processing_backend: "slurm"
    reporting_backend: "custom-slurm-api"
    # Note: membership_sync_backend is omitted

the agent starts

  • STOMP-based service only for order processing via SLURM
  • usage-reporting service using a custom SLURM API, which is provided via custom module's entry-point

Username Management

The agent supports asynchronous username generation and management for offering users. This system provides pluggable backends for custom username generation logic and handles complex scenarios with graceful error recovery.

For comprehensive documentation on username management, async user creation workflows, configuration, and custom backend development, see the Username Management Documentation.

Provider config file reference

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
sentry_dsn: "" # Data Source Name for Sentry (more info https://docs.sentry.io/product/sentry-basics/dsn-explainer/).
timezone: "UTC" # Timezone for billing period calculations (e.g. "UTC", "Europe/Tallinn").
  # Defaults to system timezone if not specified.
offerings: # Settings for offerings
  - name: "Example SLURM Offering" # offering name
    waldur_api_url: "http://localhost:8081/api/" # URL of Waldur API (e.g. http://localhost:8081/api/).
    waldur_api_token: "" # Token to access the Waldur API.
    verify_ssl: true # Whether to verify SSL cert for Waldur API.
    waldur_offering_uuid: "" # UUID of the offering in Waldur.
    # Name of the backend from entrypoints to use for username management
    username_management_backend: "base"
    # Name of the backend from entrypoints to use for order processing
    order_processing_backend: "slurm"
    # Name of the backend from entrypoints to use for membership syncing
    membership_sync_backend: "slurm"
     # Name of the backend from entrypoints to use for reporting
    reporting_backend: "slurm"
    resource_import_enabled: true # Whether to expose importable resources to Waldur
    stomp_enabled: false # STOMP feature toggler
    mqtt_enabled: true # MQTT feature toggler
    websocket_use_tls: true # Whether to use TLS for websocket connection
    backend_type: "slurm" # type of backend, for now only `slurm` and `moab` is supported
    backend_settings: # backend-specific settings
      default_account: "root" # Default parent account name in SLURM cluster
        # for new ones
      customer_prefix: "hpc_" # Prefix for customer's accounts.
      project_prefix: "hpc_" # Prefix for project's accounts.
      allocation_prefix: "hpc_" # Prefix used for allocation's accounts.
        # created by the agent.
      qos_downscaled: "limited" # The QoS set to an account after downscaling
      qos_paused: "paused" # The QoS set to an account after pausing
      qos_default: "normal" # The default QoS for account in the SLURM cluster
      enable_user_homedir_account_creation: true # Whether to create home directories
        # for users associated to accounts.
      homedir_umask: "0700" # A umask for created homedirs
    backend_components: # Computing components on backend with accounting data
      cpu: # Type of the component, for example `cpu`
        measured_unit: "k-Hours" # Waldur measured unit for accounting.
          # For example `k-Hours` for CPU
        unit_factor: 60000 # Factor for conversion from measured unit
          # to backend ones.
          # For example 60000 (60 * 1000) for CPU in SLURM,
          # which uses cpu-minutes for accounting
        accounting_type: "usage" # Can be either `usage` or `limit`
        label: "CPU" # A label for the component in Waldur
      mem:
        limit: 10 # Amount of measured units for Waldur (SLURM measured unit is MB-minutes)
        measured_unit: 'gb-Hours' # Waldur measured unit for accounting
        unit_factor: 61440 # Unit factor for conversion from measured unit
          # to SLURM units (60 * 1024)
        accounting_type: usage # Can be usage or limit
        label: RAM # A label for a component in Waldur
  - name: "Example MOAB Offering"
    waldur_api_url: "http://localhost:8081/api/"
    waldur_api_token: ""
    waldur_offering_uuid: ""
    # Name of the backend from entrypoints to use for username management
    username_management_backend: "base"
     # Name of the backend from entrypoints to use for order processing
    order_processing_backend: "moab"
    # Name of the backend from entrypoints to use for membership syncing
    membership_sync_backend: "moab"
    reporting_backend: "moab" # Name of the backend from entrypoints to use for reporting
    resource_import_enabled: false # Whether to expose importable resources to Waldur
    backend_type: "moab"
    backend_settings:
      default_account: root
      customer_prefix: "c_"
      project_prefix: "p_"
      allocation_prefix: "a_"
      enable_user_homedir_account_creation: true
    backend_components:
      deposit: # For MOAB backend, only "deposit" is supported
        measured_unit: 'EUR'
        accounting_type: limit
        label: Deposit (EUR)

Plugin Architecture

The Waldur Site Agent uses a pluggable backend system that allows external developers to create custom backend plugins without modifying the core codebase.

Core architecture & plugin system

---
config:
  layout: elk
---
graph TB
    subgraph "Core Package"
        WA[waldur-site-agent<br/>Core Logic & Processing]
        BB[BaseBackend<br/>Abstract Interface]
        BC[BaseClient<br/>Abstract Interface]
        CU[Common Utils<br/>Entry Point Discovery]
    end

    subgraph "Plugin Ecosystem"
        PLUGINS[Backend Plugins<br/>SLURM, MOAB, MUP, etc.]
        UMANAGE[Username Management<br/>Plugins]
    end

    subgraph "Entry Point System"
        EP_BACKENDS[waldur_site_agent.backends]
        EP_USERNAME[waldur_site_agent.username_management_backends]
    end

    %% Core dependencies
    WA --> BB
    WA --> BC
    WA --> CU

    %% Plugin registration and discovery
    CU --> EP_BACKENDS
    CU --> EP_USERNAME
    EP_BACKENDS -.-> PLUGINS
    EP_USERNAME -.-> UMANAGE

    %% Plugin inheritance
    PLUGINS -.-> BB
    PLUGINS -.-> BC
    UMANAGE -.-> BB

    %% Styling - Dark mode compatible colors
    classDef corePackage fill:#1E3A8A,stroke:#3B82F6,stroke-width:2px,color:#FFFFFF
    classDef plugin fill:#581C87,stroke:#8B5CF6,stroke-width:2px,color:#FFFFFF
    classDef entrypoint fill:#065F46,stroke:#10B981,stroke-width:2px,color:#FFFFFF

    class WA,BB,BC,CU corePackage
    class PLUGINS,UMANAGE plugin
    class EP_BACKENDS,EP_USERNAME entrypoint

Agent modes & external systems

---
config:
  layout: elk
---
graph TB
    subgraph "Agent Modes"
        ORDER[agent-order-process<br/>Order Processing]
        REPORT[agent-report<br/>Usage Reporting]
        SYNC[agent-membership-sync<br/>Membership Sync]
        EVENT[agent-event-process<br/>Event Processing]
    end

    subgraph "Plugin Layer"
        PLUGINS[Backend Plugins<br/>SLURM, MOAB, MUP, etc.]
    end

    subgraph "External Systems"
        WALDUR[Waldur Mastermind<br/>REST API]
        BACKENDS[Cluster Backends<br/>CLI/API Systems]
        MQTT[MQTT/STOMP Broker<br/>Event Processing]
    end

    %% Agent mode usage of plugins
    ORDER --> PLUGINS
    REPORT --> PLUGINS
    SYNC --> PLUGINS
    EVENT --> PLUGINS

    %% External connections
    ORDER <--> WALDUR
    REPORT <--> WALDUR
    SYNC <--> WALDUR
    EVENT <--> WALDUR
    EVENT <--> MQTT
    PLUGINS <--> BACKENDS

    %% Styling - Dark mode compatible colors
    classDef agent fill:#B45309,stroke:#F59E0B,stroke-width:2px,color:#FFFFFF
    classDef plugin fill:#581C87,stroke:#8B5CF6,stroke-width:2px,color:#FFFFFF
    classDef external fill:#C2410C,stroke:#F97316,stroke-width:2px,color:#FFFFFF

    class ORDER,REPORT,SYNC,EVENT agent
    class PLUGINS plugin
    class WALDUR,BACKENDS,MQTT external

Key plugin features

  • Automatic Discovery: Plugins are automatically discovered via Python entry points
  • Modular Backends: Each backend (SLURM, MOAB, MUP) is a separate plugin package
  • Independent Versioning: Plugins can be versioned and distributed separately
  • Extensible: External developers can create custom backends by implementing BaseBackend
  • Workspace Integration: Seamless development with uv workspace dependencies
  • Multi-Backend Support: Different backends for order processing, reporting, and membership sync

Plugin structure

Built-in plugin structure

1
2
3
4
5
6
7
plugins/{backend_name}/
├── pyproject.toml              # Entry point registration
├── waldur_site_agent_{name}/   # Plugin implementation
│   ├── backend.py             # Backend class inheriting BaseBackend
│   ├── client.py              # Client for external system communication
│   └── parser.py              # Data parsing utilities (optional)
└── tests/                     # Plugin-specific tests

Available plugins

SLURM plugin (waldur-site-agent-slurm)

  • Communication: CLI-based via sacctmgr, sacct, scancel commands
  • Components: CPU, memory, GPU (TRES-based accounting)
  • Features:
  • QoS management (downscale, pause, restore)
  • Home directory creation
  • Job cancellation
  • User limit management
  • Parser: Complex SLURM output parsing with time/unit conversion
  • Client: SlurmClient with command-line execution

MOAB plugin (waldur-site-agent-moab)

  • Communication: CLI-based via mam-* commands
  • Components: Deposit-based accounting only
  • Features:
  • Fund management
  • Account creation/deletion
  • Basic user associations
  • Parser: Simple report line parsing for charges
  • Client: MoabClient with MOAB Accounting Manager integration

MUP plugin (waldur-site-agent-mup)

  • Communication: HTTP REST API
  • Components: Configurable limit-based components
  • Features:
  • Project/allocation management
  • User creation and management
  • Research field mapping
  • Multi-component allocation support
  • Client: MUPClient with HTTP authentication and comprehensive API coverage
  • Advanced: Most sophisticated plugin with full user lifecycle management

Basic username management (waldur-site-agent-basic-username-management)

  • Purpose: Provides base username management interface
  • Implementation: Minimal placeholder implementation
  • Extensibility: Template for custom username generation backends

Creating Custom Plugins

Backend Plugin Development

  1. Create plugin package:
1
2
mkdir my-custom-backend
cd my-custom-backend
  1. Setup pyproject.toml:
1
2
3
4
5
6
7
[project]
name = "waldur-site-agent-mycustom"
version = "0.1.0"
dependencies = ["waldur-site-agent==0.1.0"]

[project.entry-points."waldur_site_agent.backends"]
mycustom = "waldur_site_agent_mycustom.backend:MyCustomBackend"
  1. Implement backend class:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_site_agent.backend.backends import BaseBackend

class MyCustomBackend(BaseBackend):
    def ping(self):
        # Health check implementation
        pass

    def _get_usage_report(self):
        # Usage reporting implementation
        pass

    # Implement other required methods...
  1. Install and register:
1
uv sync --all-packages

Username management plugin development

  1. Entry point registration:
1
2
[project.entry-points."waldur_site_agent.username_management_backends"]
custom_username = "your_project.backend.usernames:CustomUsernameManagementBackend"
  1. Implementation:
1
2
3
4
5
6
from waldur_site_agent.backend.backends import AbstractUsernameManagementBackend

class CustomUsernameManagementBackend(AbstractUsernameManagementBackend):
    def generate_username(self, user_data):
        # Custom username generation logic
        pass
  1. Configuration:
1
2
3
offerings:
  - name: "My Offering"
    username_management_backend: "custom_username"

Plugin discovery mechanism

The core system automatically discovers plugins through Python entry points:

1
2
3
4
5
6
from importlib.metadata import entry_points

BACKENDS = {
    entry_point.name: entry_point.load()
    for entry_point in entry_points(group="waldur_site_agent.backends")
}

This enables: - Zero-configuration discovery: Plugins are found automatically when installed - Dynamic loading: Plugin classes are loaded on-demand - Flexible deployment: Different plugin combinations for different environments - Third-party integration: External plugins work seamlessly with the core system

Configuration integration

Plugins integrate through offering configuration:

1
2
3
4
5
6
7
offerings:
  - name: "Example Offering"
    backend_type: "slurm"                    # Legacy setting
    order_processing_backend: "slurm"        # Order processing via SLURM
    reporting_backend: "custom-api"          # Custom reporting backend
    membership_sync_backend: "slurm"         # Membership sync via SLURM
    username_management_backend: "custom"    # Custom username generation

This allows: - Mixed backend usage: Different backends for different operations - Gradual migration: Transition between backends incrementally - Specialized backends: Use purpose-built backends for specific tasks - Development flexibility: Test new backends alongside production ones

Offering Users and Async User Creation

The Waldur Site Agent provides robust support for managing offering users with asynchronous username generation and state management. This system enables non-blocking user processing and supports complex username generation scenarios through a pluggable backend architecture.

Overview

Offering users represent the relationship between Waldur users and marketplace offerings. The agent handles username generation, state transitions, and integration with backend systems to ensure users can access provisioned resources.

Async User Creation Workflow

State Machine

The async user creation follows a state-based workflow that prevents blocking operations:

stateDiagram-v2
    [*] --> REQUESTED : User requests access
    REQUESTED --> CREATING : Begin username generation
    CREATING --> OK : Username successfully created
    CREATING --> PENDING_ACCOUNT_LINKING : Manual linking required
    CREATING --> PENDING_ADDITIONAL_VALIDATION : Additional validation needed
    PENDING_ACCOUNT_LINKING --> OK : Username generation succeeds on retry
    PENDING_ADDITIONAL_VALIDATION --> OK : Username generation succeeds on retry
    OK --> [*] : User ready for resource access

State Descriptions

  • REQUESTED: Initial state when user requests access to an offering
  • CREATING: Transitional state during username generation process
  • OK: Username successfully generated and user is ready for resource access
  • PENDING_ACCOUNT_LINKING: Manual intervention required to link user accounts
  • PENDING_ADDITIONAL_VALIDATION: Additional validation steps needed before proceeding

Core Components

Main Functions

sync_offering_users()

Entry point function that processes all offering users across configured offerings.

Usage:

1
uv run waldur_sync_offering_users -c config.yaml

Behavior:

  • Iterates through all configured offerings
  • Retrieves offering users from Waldur API
  • Delegates processing to update_offering_users()

update_offering_users()

Core processing function that handles username generation and state transitions.

Process: 1. Checks offering's username generation policy 2. Processes users in REQUESTED state 3. Handles users in pending states (PENDING_ACCOUNT_LINKING, PENDING_ADDITIONAL_VALIDATION) 4. Manages state transitions and error handling

Username Management Backend System

The agent uses a pluggable backend architecture for username generation, allowing custom implementations for different identity providers and naming conventions.

Base Abstract Class

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_site_agent.backend.backends import AbstractUsernameManagementBackend

class CustomUsernameBackend(AbstractUsernameManagementBackend):
    def generate_username(self, offering_user: OfferingUser) -> str:
        """Generate new username based on offering user details."""
        # Custom logic here
        return generated_username

    def get_username(self, offering_user: OfferingUser) -> Optional[str]:
        """Retrieve existing username from local identity provider."""
        # Custom lookup logic here
        return existing_username

Plugin Registration

Register your backend via entry points in pyproject.toml:

1
2
[project.entry-points."waldur_site_agent.username_management_backends"]
custom_backend = "my_package.backend:CustomUsernameBackend"

Built-in Backends

  • base: Basic username management backend (plugins/basic_username_management/)
  • UnknownUsernameManagementBackend: Fallback backend when configuration is missing

Configuration

Offering Configuration

Configure username management per offering in your agent configuration:

1
2
3
4
5
6
7
8
9
offerings:
  - name: "SLURM Cluster"
    waldur_api_url: "https://waldur.example.com/api/"
    waldur_api_token: "your-token"
    waldur_offering_uuid: "offering-uuid"
    backend_type: "slurm"
    username_management_backend: "custom_backend"  # References entry point name
    backend_settings:
      # ... other settings

Prerequisites

  1. Service Provider Username Generation: The offering must be configured with username_generation_policy = SERVICE_PROVIDER in Waldur
  2. Backend Plugin: Appropriate username management backend must be installed and configured
  3. Permissions: API token must have permissions to manage offering users

Integration with Order Processing

The async user creation system is seamlessly integrated with the agent's order processing workflows:

Automatic Processing

Username generation is automatically triggered during: - Resource creation orders - User addition to existing resources - Membership synchronization operations

Implementation in Processors

The OfferingBaseProcessor class provides _update_offering_users() method that:

  1. Calls username generation for users with blank usernames
  2. Refreshes offering user data after processing
  3. Filters users to only include those with valid usernames for resource operations

Example usage in order processing:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Before adding users to a resource
offering_users = self._get_waldur_offering_users()
self._update_offering_users(offering_users)

# Refresh data after username generation
offering_users = self._get_waldur_offering_users()

# Use only users with valid usernames
valid_usernames = {
    user.username for user in offering_users
    if user.state == OfferingUserStateEnum.OK and user.username
}

Error Handling

Exception Types

The system defines specific exceptions for different error scenarios:

  • OfferingUserAccountLinkingRequiredError: Raised when manual account linking is required
  • OfferingUserAdditionalValidationRequiredError: Raised when additional validation steps are needed

Both exceptions support an optional comment_url parameter to provide links to forms, documentation, or other resources needed for error resolution.

Error Recovery

When exceptions occur: 1. User state transitions to appropriate pending state 2. Error details are logged with context 3. Comment field is updated with error message and comment_url field with any provided URL 4. Processing continues for other users 5. Pending users are retried in subsequent runs

Best Practices

Username Backend Implementation

  1. Idempotent Operations: Ensure get_or_create_username() can be called multiple times safely
  2. Error Handling: Raise appropriate exceptions for recoverable errors
  3. Logging: Include detailed logging for troubleshooting
  4. Validation: Validate generated usernames meet backend system requirements

Deployment Considerations

  1. Regular Sync: Run waldur_sync_offering_users regularly via cron or systemd timer
  2. Monitoring: Monitor pending user states for manual intervention needs
  3. Backup Strategy: Consider username mapping backup for disaster recovery
  4. Testing: Test username generation logic thoroughly before production deployment

Troubleshooting

Diagnostic Commands

1
2
3
4
5
6
7
8
9
# Check system health
uv run waldur_site_diagnostics -c config.yaml

# Manual user sync
uv run waldur_sync_offering_users -c config.yaml

# Check offering user states via API
curl -H "Authorization: Token YOUR_TOKEN" \
  "https://waldur.example.com/api/marketplace-offering-users/?offering_uuid=OFFERING_UUID"

SLURM Usage Reporting Setup Guide

This guide explains how to set up a single Waldur Site Agent instance for usage reporting with SLURM backend. This configuration is ideal when you only need to collect and report usage data from your SLURM cluster to Waldur Mastermind.

Overview

The usage reporting agent (report mode) collects CPU, memory, and other resource usage data from SLURM accounting records and sends it to Waldur Mastermind. It runs in a continuous loop, fetching usage data for the current billing period and reporting it at regular intervals.

Prerequisites

System Requirements

  • Linux system with access to SLURM cluster head node
  • Python 3.11 or higher
  • uv package manager installed
  • Root access (required for SLURM commands)
  • Network access to Waldur Mastermind API

SLURM Requirements

  • SLURM accounting enabled (sacct and sacctmgr commands available)
  • Access to SLURM accounting database
  • Required SLURM commands:
  • sacct - for usage reporting
  • sacctmgr - for account management
  • sinfo - for cluster diagnostics

Installation

1. Clone and Install the Application

1
2
3
4
5
6
# Clone the repository
git clone https://github.com/waldur/waldur-site-agent.git
cd waldur-site-agent

# Install dependencies with SLURM plugin
uv sync --extra slurm

2. Create Configuration Directory

1
sudo mkdir -p /etc/waldur

Configuration

1. Create Configuration File

Create /etc/waldur/waldur-site-agent-config.yaml with the following configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
sentry_dsn: ""  # Optional: Sentry DSN for error tracking
timezone: "UTC"  # Timezone for billing period calculations

offerings:
  - name: "SLURM Usage Reporting"
    waldur_api_url: "https://your-waldur-instance.com/api/"
    waldur_api_token: "your-api-token-here"
    waldur_offering_uuid: "your-offering-uuid-here"

    # Backend configuration for usage reporting only
    username_management_backend: "base"  # Not used in report mode
    order_processing_backend: "slurm"   # Not used in report mode
    membership_sync_backend: "slurm"    # Not used in report mode
    reporting_backend: "slurm"          # This is what matters for reporting

    # Event processing (not needed for usage reporting)
    mqtt_enabled: false
    stomp_enabled: false

    backend_type: "slurm"
    backend_settings:
      default_account: "root"           # Root account in SLURM
      customer_prefix: "hpc_"           # Prefix for customer accounts
      project_prefix: "hpc_"            # Prefix for project accounts
      allocation_prefix: "hpc_"         # Prefix for allocation accounts

      # QoS settings (not used in report mode but required)
      qos_downscaled: "limited"
      qos_paused: "paused"
      qos_default: "normal"

      # Home directory settings (not used in report mode)
      enable_user_homedir_account_creation: false
      homedir_umask: "0700"

    # Define components for usage reporting
    backend_components:
      cpu:
        limit: 10                       # Not used in usage reporting
        measured_unit: "k-Hours"        # Waldur unit for CPU usage
        unit_factor: 60000              # Convert CPU-minutes to k-Hours (60 * 1000)
        accounting_type: "usage"        # Report actual usage
        label: "CPU"

      mem:
        limit: 10                       # Not used in usage reporting
        measured_unit: "gb-Hours"       # Waldur unit for memory usage
        unit_factor: 61440              # Convert MB-minutes to gb-Hours (60 * 1024)
        accounting_type: "usage"        # Report actual usage
        label: "RAM"

2. Configuration Parameters Explained

Waldur Connection

  • waldur_api_url: URL to your Waldur Mastermind API endpoint
  • waldur_api_token: API token for authentication (create in Waldur admin)
  • waldur_offering_uuid: UUID of the SLURM offering in Waldur

Backend Settings

  • default_account: Root account in SLURM cluster
  • Prefixes: Used to identify accounts created by the agent (for filtering)

Backend Components

  • cpu: CPU usage tracking in CPU-minutes (SLURM native unit)
  • mem: Memory usage tracking in MB-minutes (SLURM native unit)
  • unit_factor: Conversion factor from SLURM units to Waldur units
  • accounting_type: "usage": Report actual usage (not limits)

Deployment

  1. Copy service file:
1
sudo cp systemd-conf/agent-report/agent.service /etc/systemd/system/waldur-site-agent-report.service
  1. Reload systemd and enable service:
1
2
3
sudo systemctl daemon-reload
sudo systemctl enable waldur-site-agent-report.service
sudo systemctl start waldur-site-agent-report.service
  1. Check service status:
1
sudo systemctl status waldur-site-agent-report.service

Option 2: Manual Execution

For testing or one-time runs:

1
2
3
4
5
# Run directly
uv run waldur_site_agent -m report -c /etc/waldur/waldur-site-agent-config.yaml

# Or with installed package
waldur_site_agent -m report -c /etc/waldur/waldur-site-agent-config.yaml

Operation

How It Works

  1. Initialization: Agent loads configuration and connects to SLURM cluster
  2. Account Discovery: Identifies accounts matching configured prefixes
  3. Usage Collection:
  4. Runs sacct to collect usage data for current billing period
  5. Aggregates CPU and memory usage per account and user
  6. Converts SLURM units to Waldur units using configured factors
  7. Reporting: Sends usage data to Waldur Mastermind API
  8. Sleep: Waits for configured interval (default: 30 minutes)
  9. Repeat: Returns to step 3

Timing Configuration

Control reporting frequency with environment variable:

1
2
# Report every 15 minutes instead of default 30
export WALDUR_SITE_AGENT_REPORT_PERIOD_MINUTES=15

Logging

Systemd Service Logs

1
2
3
4
5
# View service logs
sudo journalctl -u waldur-site-agent-report.service -f

# View logs for specific time period
sudo journalctl -u waldur-site-agent-report.service --since "1 hour ago"

Manual Execution Logs

Logs are written to stdout/stderr when running manually.

Monitoring and Troubleshooting

Health Checks

  1. Test SLURM connectivity:
1
uv run waldur_site_diagnostics
  1. Verify configuration:
1
2
# Check if configuration is valid
uv run waldur_site_agent -m report -c /etc/waldur/waldur-site-agent-config.yaml --dry-run

Common Issues

SLURM Commands Not Found

  • Ensure SLURM tools are in PATH
  • Verify sacct and sacctmgr are executable
  • Check SLURM accounting is enabled

Authentication Errors

  • Verify Waldur API token is valid
  • Check network connectivity to Waldur Mastermind
  • Ensure offering UUID exists in Waldur

No Usage Data

  • Verify accounts exist in SLURM with configured prefixes
  • Check SLURM accounting database has recent data
  • Ensure users have submitted jobs in the current billing period

Permission Errors

  • Agent typically needs root access for SLURM commands
  • Verify service runs as root user
  • Check file permissions on configuration file

Debugging

Enable debug logging by setting environment variable:

1
export WALDUR_SITE_AGENT_LOG_LEVEL=DEBUG

Data Flow

1
2
3
4
5
6
SLURM Cluster → sacct command → Usage aggregation → Unit conversion → Waldur API
     ↓              ↓                    ↓                ↓              ↓
- Job records  - CPU-minutes      - Per-account    - k-Hours     - POST usage
- Resource     - MB-minutes       - Per-user       - gb-Hours      data
  usage        - Account data     - Totals         - Converted
                                                    values

Security Considerations

  1. API Token Security: Store Waldur API token securely, restrict file permissions
  2. Root Access: Agent needs root for SLURM commands - run in controlled environment
  3. Network: Ensure secure connection to Waldur Mastermind (HTTPS)
  4. Logging: Avoid logging sensitive data, configure log rotation

Integration Notes

This setup is designed for usage reporting only. For a complete Waldur Site Agent deployment that includes:

  • Order processing (resource creation/deletion)
  • Membership synchronization
  • Event processing

You would need additional agent instances or a multi-mode configuration with different service files for each mode.

Ended: Docs

Ended: Providers

Waldur on RKE2

RKE2 installation and setup

To install Waldur on top of RKE2 you need to:

  1. Install Ansible with version >= 2.10 and ensure python3 is installed.

  2. Download this repository

  3. At least 3 nodes with minimal requirements for Kubernetes nodes

    1
2
3
    8GB RAM
4 vCPU
30GB for system volume and a dedicated 60GB for storage (Longhorn)

  4. Install kubernetes.core collection from ansible galaxy.

    1
2
3
4
5
6
7
8
    ansible-galaxy collection install kubernetes.core
ansible-galaxy collection install ansible.posix
# or
curl -L -o ansible-galaxy/kubernetes-core-2.3.2.tar.gz --create-dirs https://galaxy.ansible.com/download/kubernetes-core-2.3.2.tar.gz
ansible-galaxy collection install ansible-galaxy/kubernetes-core-2.3.2.tar.gz

curl -L -o ansible-galaxy/ansible-posix-1.4.0.tar.gz https://galaxy.ansible.com/download/ansible-posix-1.4.0.tar.gz
ansible-galaxy collection install ansible-galaxy/ansible-posix-1.4.0.tar.gz

  5. Adjust variables in ansible-config/rke2_vars file

  6. (Optional) Run the playbook to setup infrastructure (Kubernetes and Longhorn):

    1
2
    cd ansible-config
ansible-playbook -D -i rke2_inventory install-infrastructure.yaml

  7. Run the playbook to install Waldur and dependencies:

    1
2
    cd ansible-config
ansible-playbook -D -i rke2_inventory install-applications.yaml

You can check Waldur release installation with the following steps:

  1. ssh to a node from inventory with initial_server=true and check all the pods from the default namespace:

    1
2
    export KUBECONFIG=/etc/rancher/rke2/rke2.yaml
kubectl get pods -n default

If you run Waldur in a different namespace, please adjust the value of the -n option in the last command above.

Add admin ssh keys

  1. Setup admin_keys and revoked_admin_keys vars in the ansible-config/rke2_vars file

  2. Run the corresponding playbook

    1
2
    cd ansible-config
ansible-playbook -D -i rke2_inventory add-ssh-keys.yml

Add haproxy load balancer

  1. Setup haproxy_stats_password var in the ansible-config/rke2_vars file

  2. Run the corresponding playbook

    1
2
    cd ansible-config
ansible-playbook -D -i rke2_inventory add-haproxy-host.yml

Waldur Helm configuration

A user can override default settings for Waldur Helm. The ansible-config/waldur/values.yaml is the main settings file. Additional configuration features files (e.g. for SAML2, whitelabeling, bootstrapping, etc.) can be included by placing into corresponding subdirectories of ansible-config/waldur/ folder. The paths to the subdirectories should be specified in ansible-config/waldur/values.yaml, e.g. waldur.saml2.dir value.

Waldur Helm configuration is described in the public docs; example values.yaml file: link, example additional files: link.

Update of Waldur

To update Waldur user needs to execute the corresponding playbook:

1
2
cd ansible-config
ansible-playbook -D -i rke2_inventory update-waldur.yaml

Update of Waldur dependencies

To update Waldur dependencies, a user should:

  1. Setup the desired components for update in ansible-config/rke2_vars file, e.g. set setup_postgresql to yes in case of PostgreSQL Helm chart update. NB: please, don't change chart versions manually, it can cause failure of Waldur application

  2. Run the corresponding playbook:

    1
2
    cd ansible-config
ansible-playbook -D -i rke2_inventory install-applications.yaml

Example of changes in ansible-config/rke2_vars file:

1
2
3
4
5
6
7
8
9
# Waldur dependency setup
setup_postgresql: yes # User can skip PostgreSQL setup
postgresql_version: 11.9.1 # Version of PostgreSQL Helm chart

setup_rabbitmq: no # User can skip RabbitMQ setup
rabbitmq_version: 10.3.5 # Version of RabbitMQ Helm chart

setup_minio: no # User can skip MinIO setup
minio_version: 11.10.16 # Version of MinIO Helm chart

With this setup, the playbook will update PostgreSQL release only. If the user wants to update RabbitMQ too, they should set setup_rabbitmq: yes

Waldur log fetching

To get logs from Waldur containers, a users needs to connect to one of the RKE2 nodes:

1
ssh <node-ip>

A node IP should be chosen from the inventory file (e.g. rke2_inventory).

In the node's shell, the user should run the following to setup Kubernetes client:

1
export KUBECONFIG=/etc/rancher/rke2/rke2.yaml

After this, the user can get Waldur API logs:

1
kubectl logs --tail 100 -l app=waldur-mastermind-api -n default

Same works for Celery worker:

1
kubectl logs --tail 100 -l app=waldur-mastermind-worker -n default

Note: if you use a non-default namespace for Waldur release, please change the value for -n option in the aforementioned command

Setup SSL certificates

NB: do not forget to set apiScheme ans homeportScheme to https in ansible-config/waldur/values.yaml

Custom certificates

To setup the SSL certificates, please do the following steps:

  1. Copy the certificate and key to the ansible-config/waldur/tls directory. NB: key must be named tls.key and cert itself - tls.crt
  2. In ansible-config/waldur/values.yaml, set ingress.tls.source to secret
  3. Update Waldur release

Let's Encrypt

To setup SSL certificates using Let's Encrypt, please do the following steps:

  1. In ansible-config/rke2_vars, set setup_lets_encrypt to yes
  2. In ansible-config/waldur/values.yaml, set ingress.tls.source to letsEncrypt
  3. Install Let's Encrypt via install-applications.yaml playbook
1
ansible-playbook -D -i rke2_inventory -e "setup_k8s_dashboard=no setup_loki_prom_grafana=no setup_postgresql=no setup_rabbitmq=no setup_minio=no" install-applications.yaml
  1. Update Waldur release

Enable K8s dashboard

Make sure that K8s dashboard is deployed. Login to one of the K8s nodes.

1
2
3
4
5
# create / renew token for admin user
kubectl -n kubernetes-dashboard create token admin-user

# setup kubectl port fortward to k8s-dashboard service
kubectl port-forward -n kubernetes-dashboard service/kubernetes-dashboard --address 0.0.0.0 8001:443

K8s dashboard should now be accessible on port 8001 in that node -- or load balancer node on port 8001 if configured.

Recover data from DB backup

In order to apply an existing backup to database, a corresponding playbook exists.

NB:

  • This operation drops an existing database, creates an empty one and applies the pre-created backup
  • During restoration process, the site will be unavailable

During execution, you will be asked about backup name. You should input it in a correct way. Example of running playbook:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
TASK [List backups] ****************************************************************************************************************************************
ok: [csl-stg-kubs01] => {}

MSG:

[+] LOCAL_PG_BACKUPS_DIR :
[+] MINIO_PG_BACKUPS_DIR : pg/data/backups/postgres
[+] Setting up the postgres alias for minio server (http://minio.default.svc.cluster.local:9000)
[+] Last 5 backups
[2022-12-01 05:00:02 UTC]  91KiB backup-2022-12-01-05-00.sql.gz
[2022-11-30 05:00:02 UTC]  91KiB backup-2022-11-30-05-00.sql.gz
[2022-11-29 05:00:02 UTC]  91KiB backup-2022-11-29-05-00.sql.gz
[2022-11-28 16:30:37 UTC]  91KiB backup-2022-11-28-16-30.sql.gz
[2022-11-28 16:28:27 UTC]  91KiB backup-2022-11-28-16-28.sql.gz
[+] Finished
[Choose backup]
Please enter backup's name:

After this, you should input one of the following lines:

  • backup-2022-12-01-05-00.sql.gz
  • backup-2022-11-30-05-00.sql.gz
  • backup-2022-11-29-05-00.sql.gz
  • backup-2022-11-28-16-30.sql.gz
  • backup-2022-11-28-16-28.sql.gz

Otherwise, the entire process will fail, but the site and database with old data will be still available.

To start the process, please, execute the following line in the machine connected to RKE2 nodes:

1
ansible-playbook -D -i rke2_inventory restore-data.yaml

Ended: Rke2 setup

Ended: Admin guide

Developer guide ↵

Developer documentation

This documentation provides comprehensive guidance for Waldur development. It covers essential topics including installation and setup, core architectural concepts like permissions and managed entities, background processing systems, and development best practices.

Key areas covered:

  • Installation and development workflow setup
  • Core concepts: permissions, managed entities, background processing, quotas, logging
  • Development guides: serializers, views, tests, documentation, resource actions
  • Localization and internationalization
  • System architecture: events, models, templates
  • Plugin development and existing plugin implementations

Background processing

For executing heavier requests and performing background tasks Waldur is using Celery. Celery is a task queue that supports multiple backends for storing the tasks and results.

Currently Waldur is relying on RabbitMQ backend - RabbitMQ server must be running for requests triggering background scheduling to succeed.

Finite state machines

Some of the models in Waldur have a state field representing their current condition. The state field is implemented as a finite state machine. Both user requests and background tasks can trigger state transition. A REST client can observe changes to the model instance through polling the state field of the object.

Let's take VM instance in 'offline' state. A user can request the instance to start by issuing a corresponding request over REST. This will schedule a task in Celery and transition instance status to 'starting_scheduled'. Further user requests for starting an instance will get state transition validation error. Once the background worker starts processing the queued task, it updates the Instance status to the 'starting'. On task successful completion, the state is transitioned to 'online' by the background task.

Error state of background tasks

If a background task has failed to achieve it's goal, it should transit into an error state. To propagate more information to the user each model with an FSM field should include a field for error message information - error_message. The field should be exposed via REST. Background task should update this field before transiting into an erred state.

Cleaning of the error state of the model instance should clean up also error_message field.

Core Checklists

The core checklist module provides a flexible questionnaire system that enables organizations to manage various types of compliance and metadata requirements through customizable questionnaires with conditional logic and review workflows.

Overview

The checklist system is designed as an extendable staff-configured metadata schema to be used in different scenarios, for example:

  • Project Metadata: Extendable schema for project metadata
  • Project Compliance: Ensures projects meet organizational standards
  • Proposal Compliance: Validates proposals before submission
  • Offering Compliance: Verifies marketplace offerings meet requirements

Core Models

Category

Groups checklists by category with icon support for UI display. Categories provide organizational structure for managing different types of compliance checklists.

Checklist

Main container for compliance questions. Each checklist has a type (project/proposal/offering compliance/project metadata) and contains an ordered set of questions that users must complete.

Key features:

  • Type-based categorization (project_compliance, proposal_compliance, offering_compliance, project_metadata)
  • Dynamic question visibility based on user context and dependencies
  • Optional category grouping for UI organization
  • Timestamped for audit trail

Question

Individual questions with configurable types, ordering, conditional user guidance, and review trigger logic based on answer values.

Question Types:

  • Boolean: Yes/No/N/A responses
  • Single Select: Choose one option from a list
  • Multi Select: Choose multiple options from a list
  • Text Input: Short text responses
  • Text Area: Long text responses
  • Number: Numeric input with optional min/max validation constraints
  • Date: Date selection
  • File: File upload (planned)

Features:

  • Conditional visibility based on dependencies
  • Review triggering based on answer values
  • Conditional user guidance display
  • Required/optional questions
  • Ordered display

NUMBER Question Type Validation

NUMBER type questions support optional validation constraints for form generation and server-side validation:

  • min_value: Minimum allowed numeric value (decimal field with 4 decimal places)
  • max_value: Maximum allowed numeric value (decimal field with 4 decimal places)
  • Validation: Server-side validation rejects answers outside the specified range
  • UI Integration: Min/max values are exposed through serializers for client-side form constraints
  • Format Support: Accepts both integer and floating-point numbers

Example API Usage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
POST /api/checklists-admin-questions/
Content-Type: application/json

{
  "description": "Enter project budget (in thousands)",
  "question_type": "number",
  "checklist": "http://localhost:8000/api/checklists-admin/{checklist_uuid}/",
  "required": true,
  "min_value": "1.0",
  "max_value": "10000.0",
  "user_guidance": "Budget should be in thousands of dollars (e.g., 100 for $100,000)",
  "order": 1
}

Validation Scenarios:

  • Budget ranges (e.g., $1K - $10M)
  • Percentages (0-100)
  • Age ranges (18-100)
  • Scientific measurements with decimal precision
  • Counts and quantities with natural limits

QuestionOption

Multiple choice options for select-type questions with ordering support. Provides the available choices for single-select and multi-select questions.

QuestionDependency

Conditional visibility logic - questions can depend on other questions' answers with circular dependency prevention. This enables dynamic questionnaires that adapt based on user responses.

Operators supported:

  • equals: Exact match
  • not_equals: Not equal to
  • contains: Text contains substring
  • in: Value exists in list
  • not_in: Value does not exist in list

Dependency Logic Operators:

Questions with multiple dependencies can use different logic operators to determine visibility:

  • and (default): All conditions must be true - Question is visible only when ALL dependencies are satisfied
  • or: Any condition must be true - Question is visible when AT LEAST ONE dependency is satisfied

Example: A security question might be shown if the project handles personal data OR processes payments OR stores sensitive information.

ChecklistCompletion

Generic completion tracking model that links checklists to any domain object (proposals, projects, etc.) using Django's generic foreign key system.

Features:

  • Generic foreign key to any model (scope)
  • Completion status tracking
  • Review requirement detection
  • Reviewer assignment and notes
  • Completion percentage calculation

Answer

User responses linked to ChecklistCompletion objects, stored as JSON with automatic review flagging and reviewer tracking.

Features:

  • Flexible JSON storage for different answer types
  • Automatic review requirement detection based on question configuration
  • Review workflow with reviewer assignment and notes
  • Audit trail with timestamps
  • Answer validation based on question type
  • Unique constraints per completion/question/user

API Endpoints

Core Endpoints

  • GET /api/checklists-admin-categories/ - List checklist categories
  • GET /api/checklists-admin-categories/{uuid}/ - Category details

Admin Endpoints (Staff Only)

  • GET /api/checklists-admin/ - List checklists (staff only)
  • POST /api/checklists-admin/ - Create checklist (staff only)
  • GET /api/checklists-admin/{uuid}/ - Checklist details (staff only)
  • PUT/PATCH /api/checklists-admin/{uuid}/ - Update checklist (staff only)
  • DELETE /api/checklists-admin/{uuid}/ - Delete checklist (staff only)

  • GET /api/checklists-admin/{uuid}/questions/ - List checklist questions (staff only)

  • GET /api/checklists-admin-questions/ - List all questions (staff only)

  • POST /api/checklists-admin-questions/ - Create question (staff only)
  • GET /api/checklists-admin-questions/{uuid}/ - Question details (staff only)
  • PUT/PATCH /api/checklists-admin-questions/{uuid}/ - Update question (staff only)

  • DELETE /api/checklists-admin-questions/{uuid}/ - Delete question (staff only)

  • GET /api/checklists-admin-question-options/ - List question options (staff only)

  • POST /api/checklists-admin-question-options/ - Create option (staff only)
  • GET /api/checklists-admin-question-dependencies/ - List question dependencies (staff only)
  • POST /api/checklists-admin-question-dependencies/ - Create question dependency (staff only)
  • Full CRUD operations on question options and dependencies

Integration via ViewSet Mixins

The core checklist module provides ViewSet mixins for integration into other apps:

UserChecklistMixin - For end users filling checklists:

  • GET /{app}/{uuid}/checklist/ - Get checklist questions with user's answers
  • GET /{app}/{uuid}/completion_status/ - Get completion status
  • POST /{app}/{uuid}/submit_answers/ - Submit answers (including answer removal)

ReviewerChecklistMixin - For reviewers (with sensitive review logic):

  • GET /{app}/{uuid}/checklist_review/ - Get full checklist with review triggers
  • GET /{app}/{uuid}/completion_review_status/ - Get completion with review details

Examples:

  • GET /api/proposals/{uuid}/checklist/ - Get proposal checklist
  • POST /api/proposals/{uuid}/submit_answers/ - Submit proposal answers
  • GET /api/proposals/{uuid}/checklist_review/ - Review proposal checklist (reviewers only)

Question Dependencies

The system supports sophisticated conditional logic through question dependencies:

  1. Simple Dependencies: Show Question B only if Question A equals specific value
  2. Complex Dependencies: Multiple conditions with different operators and logic
  3. Circular Prevention: Automatic detection and prevention of circular dependencies
  4. Dynamic Visibility: Real-time question showing/hiding based on current answers

Multiple Dependency Logic

Questions can have multiple dependencies evaluated using different logic operators:

AND Logic (Default)

Question visible only when ALL dependencies are satisfied:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Create question with AND logic (default)
POST /api/checklists-admin-questions/
{
  "description": "Cloud security configuration details",
  "question_type": "text_area",
  "dependency_logic_operator": "and"
}

# Question visible only when user selects "cloud" AND "production"
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{security_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{environment_question_uuid}/",
  "required_answer_value": "production",
  "operator": "equals"
}

POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{security_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{deployment_question_uuid}/",
  "required_answer_value": "cloud",
  "operator": "equals"
}

OR Logic

Question visible when ANY dependency is satisfied:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Create question with OR logic
POST /api/checklists-admin-questions/
{
  "description": "Data protection measures",
  "question_type": "multi_select",
  "dependency_logic_operator": "or"
}

# Question visible when user handles personal data OR financial data OR health data
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{protection_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{data_type_question_uuid}/",
  "required_answer_value": ["personal", "financial", "health"],
  "operator": "in"
}

POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{protection_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{compliance_question_uuid}/",
  "required_answer_value": true,
  "operator": "equals"
}

Example: A security questionnaire might show cloud-specific questions if the user indicates they use cloud services, and data protection questions if they handle sensitive data OR require compliance.

Answer Management

Answer Submission and Updates

Users can submit, update, and remove answers through the submit_answers endpoint:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
POST /api/{app}/{uuid}/submit_answers/
Content-Type: application/json

[
  {
    "question_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "answer_data": "New answer value"
  },
  {
    "question_uuid": "456e7890-e12b-34c5-d678-901234567890",
    "answer_data": null  // Remove existing answer
  }
]

Answer Removal

Users can remove their answers by submitting null as the answer_data value. This performs a hard deletion of the answer record and automatically:

  • Recalculates completion percentage - Removed answers no longer count toward completion
  • Updates completion status - Required questions with removed answers mark checklist as incomplete
  • Updates review requirements - Removing answers that triggered reviews clears the review flag
  • Maintains audit trail - Through Answer model timestamps before deletion

Key Features:

  • Safe operations: Attempting to remove non-existent answers succeeds without errors
  • Mixed operations: Single request can create, update, and remove answers simultaneously
  • Validation bypass: Null values skip validation since they indicate removal intent
  • Status synchronization: Completion and review status automatically updated after changes

Example - Mixed Operations:

1
2
3
4
5
6
POST /api/proposals/{uuid}/submit_answers/
[
  {"question_uuid": "q1-uuid", "answer_data": true},        // Create/update
  {"question_uuid": "q2-uuid", "answer_data": null},        // Remove
  {"question_uuid": "q3-uuid", "answer_data": "New text"}   // Create/update
]

Review Workflow

Questions can be configured to trigger reviews based on answers:

  1. Automatic Review Triggers: Specific answer values trigger review requirements
  2. Always Review: Questions that always require review regardless of answer
  3. Review Assignment: Staff can be assigned to review flagged answers
  4. Review Notes: Internal notes and approval tracking

Configuring Conditional Visibility via REST API

The checklist system supports sophisticated conditional logic through two mechanisms: Question Dependencies (for question visibility) and Conditional User Guidance (for guidance text display). Both use the same flexible operator-based system.

Supported Operators

All conditional logic supports these operators, with specific question type compatibility:

  • equals - Exact match
  • Compatible with: NUMBER, DATE, BOOLEAN question types

  • Example: Check if boolean answer is true, or if number equals 100

  • not_equals - Not equal to

  • Compatible with: NUMBER, DATE, BOOLEAN question types

  • Example: Check if boolean answer is not false, or if number is not 0

  • contains - Text contains substring

  • Compatible with: TEXT_INPUT, TEXT_AREA question types
  • Example: Check if text answer contains "sensitive" or "export"

  • Note: Case-sensitive matching

  • in - Value exists in list

  • Compatible with: SINGLE_SELECT, MULTI_SELECT question types
  • Example: Check if selected option is one of ["high", "critical", "urgent"]
  • Note: For single-select, checks if the selected value is in the condition list

  • Note: For multi-select, checks if any selected value is in the condition list

  • not_in - Value does not exist in list

  • Compatible with: SINGLE_SELECT, MULTI_SELECT question types
  • Example: Check if selected option is not one of ["low", "minimal"]
  • Note: For single-select, checks if the selected value is not in the condition list
  • Note: For multi-select, checks if none of the selected values are in the condition list

Question Dependencies (Conditional Visibility)

Configure questions to show/hide based on answers to other questions.

Creating a Question Dependency

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-question-dependencies/
Content-Type: application/json

{
  "question": "http://localhost:8000/api/checklists-admin-questions/{dependent_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{trigger_question_uuid}/",
  "required_answer_value": "yes",
  "operator": "equals"
}

Example Scenarios

1. Show cloud questions only if user selects "cloud" deployment:

1
2
3
4
5
6
7
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{cloud_provider_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{deployment_type_question_uuid}/",
  "required_answer_value": "cloud",
  "operator": "equals"
}

2. Show security questions if user indicates sensitive data:

1
2
3
4
5
6
7
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{security_measures_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{has_sensitive_data_question_uuid}/",
  "required_answer_value": true,
  "operator": "equals"
}

3. Show budget questions for high-value options:

1
2
3
4
5
6
7
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{budget_approval_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{project_category_question_uuid}/",
  "required_answer_value": ["enterprise", "large_scale"],
  "operator": "in"
}

Conditional User Guidance

Configure guidance text to appear based on user answers.

Creating a Question with Always-Visible Guidance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
POST /api/checklists-admin-questions/
Content-Type: application/json

{
  "description": "Does your project handle personal data?",
  "question_type": "boolean",
  "checklist": "http://localhost:8000/api/checklists-admin/{checklist_uuid}/",
  "user_guidance": "Personal data includes names, emails, addresses, and any identifiable information.",
  "always_show_guidance": true,
  "order": 1,
  "required": true
}

Creating a Question with Conditional Guidance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
POST /api/checklists-admin-questions/
Content-Type: application/json

{
  "description": "What type of deployment will you use?",
  "question_type": "single_select",
  "checklist": "http://localhost:8000/api/checklists-admin/{checklist_uuid}/",
  "user_guidance": "Since you selected cloud deployment, ensure you have reviewed our cloud security guidelines and compliance requirements.",
  "always_show_guidance": false,
  "guidance_answer_value": "cloud",
  "guidance_operator": "equals",
  "order": 2,
  "required": true
}

Updating Conditional Guidance

1
2
3
4
5
6
7
8
9
PATCH /api/checklists-admin-questions/{question_uuid}/
Content-Type: application/json

{
  "user_guidance": "Updated guidance text for enterprise projects",
  "always_show_guidance": false,
  "guidance_answer_value": "enterprise",
  "guidance_operator": "equals"
}

Example Scenarios

1. Show compliance guidance only for "Yes" answers:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "Will you be processing EU citizen data?",
  "question_type": "boolean",
  "user_guidance": "Since you're processing EU data, you must comply with GDPR requirements. Please review our GDPR compliance checklist.",
  "always_show_guidance": false,
  "guidance_answer_value": true,
  "guidance_operator": "equals"
}

2. Show warning guidance for multiple selections:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "Which data types will you collect?",
  "question_type": "multi_select",
  "user_guidance": "You've selected multiple sensitive data types. Additional security measures and approvals may be required.",
  "always_show_guidance": false,
  "guidance_answer_value": ["personal_data", "financial_data", "health_data"],
  "guidance_operator": "in"
}

3. Show budget guidance for high-value project categories:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "What is your project category?",
  "question_type": "single_select",
  "user_guidance": "Enterprise and large-scale projects require additional financial approvals. Please prepare detailed budget documentation.",
  "always_show_guidance": false,
  "guidance_answer_value": ["enterprise", "large_scale"],
  "guidance_operator": "in"
}

Complex Scenarios

Multi-Level Dependencies

Create cascading question visibility:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# First level: Show cloud questions if deployment is cloud
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{cloud_provider_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{deployment_type_question_uuid}/",
  "required_answer_value": "cloud",
  "operator": "equals"
}

# Second level: Show AWS-specific questions if provider is AWS
POST /api/checklists-admin-question-dependencies/
{
  "question": "http://localhost:8000/api/checklists-admin-questions/{aws_region_question_uuid}/",
  "depends_on_question": "http://localhost:8000/api/checklists-admin-questions/{cloud_provider_question_uuid}/",
  "required_answer_value": "aws",
  "operator": "equals"
}

Combined Review Triggers and Guidance

Configure a question that both shows guidance and triggers reviews:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
POST /api/checklists-admin-questions/
{
  "description": "Does your application handle financial transactions?",
  "question_type": "boolean",
  "required": true,

  // Conditional guidance
  "user_guidance": "Financial transaction handling requires PCI DSS compliance and additional security reviews.",
  "always_show_guidance": false,
  "guidance_answer_value": true,
  "guidance_operator": "equals",

  // Review trigger (same condition)
  "review_answer_value": true,
  "operator": "equals",
  "always_requires_review": false
}

API Response Examples

When questions are retrieved through user-facing endpoints, conditional logic is automatically applied:

Question with visible guidance:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "What is your deployment type?",
  "question_type": "single_select",
  "user_guidance": "Since you selected cloud deployment, review our cloud security guidelines.",
  "existing_answer": {
    "answer_data": "cloud"
  },
  "question_options": [
    {"uuid": "...", "label": "On-premise", "order": 1},
    {"uuid": "...", "label": "Cloud", "order": 2},
    {"uuid": "...", "label": "Hybrid", "order": 3}
  ]
}

Question with hidden guidance (condition not met):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "What is your deployment type?",
  "question_type": "single_select",
  "user_guidance": null,
  "existing_answer": {
    "answer_data": "on-premise"
  },
  "question_options": [...]
}

Configuring Review Triggers and User Guidance

Beyond conditional visibility, questions can be configured with review triggers (to flag answers for staff review) and conditional user guidance (to show context-sensitive help text). Both features use the same operator system for maximum flexibility.

Review Trigger Configuration

Review triggers automatically flag specific answers for staff review, enabling compliance workflows and quality control.

Basic Review Trigger Setup

1. Always Require Review:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /api/checklists-admin-questions/
Content-Type: application/json

{
  "description": "Will this project involve processing personal data?",
  "question_type": "boolean",
  "checklist": "http://localhost:8000/api/checklists-admin/{checklist_uuid}/",
  "required": true,
  "always_requires_review": true,
  "order": 1
}

2. Conditional Review Trigger:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
POST /api/checklists-admin-questions/
Content-Type: application/json

{
  "description": "What type of data will you be processing?",
  "question_type": "multi_select",
  "checklist": "http://localhost:8000/api/checklists-admin/{checklist_uuid}/",
  "required": true,
  "always_requires_review": false,
  "review_answer_value": ["personal_data", "financial_data", "health_data"],
  "operator": "in",
  "order": 2
}

Review Trigger Scenarios

1. Security Review for High-Risk Projects:

1
2
3
4
5
6
7
8
POST /api/checklists-admin-questions/
{
  "description": "What is your project's risk level?",
  "question_type": "single_select",
  "review_answer_value": ["high", "critical"],
  "operator": "in",
  "always_requires_review": false
}

2. Budget Review for Large Expenditures:

1
2
3
4
5
6
7
8
POST /api/checklists-admin-questions/
{
  "description": "Select your budget range:",
  "question_type": "single_select",
  "review_answer_value": "over_100k",
  "operator": "equals",
  "always_requires_review": false
}

3. Compliance Review for Specific Text Content:

1
2
3
4
5
6
7
8
POST /api/checklists-admin-questions/
{
  "description": "Describe your data handling procedures:",
  "question_type": "text_area",
  "review_answer_value": "export",
  "operator": "contains",
  "always_requires_review": false
}

4. Multiple Review Conditions:

1
2
3
4
5
6
7
8
POST /api/checklists-admin-questions/
{
  "description": "Which compliance frameworks apply?",
  "question_type": "multi_select",
  "review_answer_value": ["gdpr", "hipaa", "sox", "pci_dss"],
  "operator": "in",
  "always_requires_review": false
}

Advanced User Guidance Configuration

User guidance provides contextual help that appears based on user answers, improving completion rates and data quality.

Static vs Conditional Guidance

1. Static Guidance (Always Visible):

1
2
3
4
5
6
7
POST /api/checklists-admin-questions/
{
  "description": "Enter your project start date:",
  "question_type": "date",
  "user_guidance": "The project start date should be when actual development work begins, not when planning started.",
  "always_show_guidance": true
}

2. Conditional Guidance (Answer-Dependent):

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "Will you be using cloud services?",
  "question_type": "boolean",
  "user_guidance": "Since you're using cloud services, please ensure you review our cloud security checklist and obtain necessary approvals before proceeding.",
  "always_show_guidance": false,
  "guidance_answer_value": true,
  "guidance_operator": "equals"
}

User Guidance Scenarios

1. Regulatory Guidance for EU Users:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "Which regions will your service operate in?",
  "question_type": "multi_select",
  "user_guidance": "Since you selected EU regions, you must comply with GDPR. Please review our GDPR compliance guide and ensure you have a lawful basis for processing personal data.",
  "always_show_guidance": false,
  "guidance_answer_value": ["eu", "uk"],
  "guidance_operator": "in"
}

2. Technical Guidance for Specific Technologies:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "Which technologies will you use?",
  "question_type": "multi_select",
  "user_guidance": "Since you're using AI/ML technologies, additional ethical review and bias testing may be required. Please consult with our AI Ethics team.",
  "always_show_guidance": false,
  "guidance_answer_value": ["machine_learning", "artificial_intelligence", "deep_learning"],
  "guidance_operator": "in"
}

3. Process Guidance for Complex Workflows:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "How many users will access this system?",
  "question_type": "single_select",
  "user_guidance": "For enterprise-scale deployments, you'll need to complete additional capacity planning and load testing requirements. Please coordinate with the Infrastructure team.",
  "always_show_guidance": false,
  "guidance_answer_value": ["1000_plus", "enterprise"],
  "guidance_operator": "in"
}

4. Warning Guidance for Risk Factors:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin-questions/
{
  "description": "Will you be integrating with external systems?",
  "question_type": "boolean",
  "user_guidance": "⚠️ External integrations require security review and may need additional authentication mechanisms. Please document all external connections and data flows.",
  "always_show_guidance": false,
  "guidance_answer_value": true,
  "guidance_operator": "equals"
}

Combined Review and Guidance Workflows

Configure questions that both provide guidance and trigger reviews for comprehensive workflows.

Example: Financial Transaction Handling

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
POST /api/checklists-admin-questions/
Content-Type: application/json

{
  "description": "Will your application process financial transactions?",
  "question_type": "boolean",
  "checklist": "http://localhost:8000/api/checklists-admin/{checklist_uuid}/",
  "required": true,
  "order": 5,

  // User guidance for "Yes" answers
  "user_guidance": "Financial transaction processing requires PCI DSS compliance. Please review our payment processing guidelines and ensure all credit card data is properly secured.",
  "always_show_guidance": false,
  "guidance_answer_value": true,
  "guidance_operator": "equals",

  // Review trigger for the same condition
  "review_answer_value": true,
  "operator": "equals",
  "always_requires_review": false
}

Example: Multi-Condition Security Workflow

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
POST /api/checklists-admin-questions/
{
  "description": "Select all data types you'll be handling:",
  "question_type": "multi_select",
  "required": true,

  // Guidance for any sensitive data
  "user_guidance": "You've selected sensitive data types. Additional security measures, encryption, and audit logging will be required. Please coordinate with the Security team early in your project.",
  "always_show_guidance": false,
  "guidance_answer_value": ["personal_data", "financial_data", "health_data", "confidential"],
  "guidance_operator": "in",

  // Review trigger for high-risk combinations
  "review_answer_value": ["financial_data", "health_data"],
  "operator": "in",
  "always_requires_review": false
}

Updating Existing Questions

Adding Review Triggers to Existing Questions

1
2
3
4
5
6
7
8
PATCH /api/checklists-admin-questions/{question_uuid}/
Content-Type: application/json

{
  "review_answer_value": ["high_risk", "critical"],
  "operator": "in",
  "always_requires_review": false
}

Modifying User Guidance

1
2
3
4
5
6
7
8
9
PATCH /api/checklists-admin-questions/{question_uuid}/
Content-Type: application/json

{
  "user_guidance": "Updated guidance text with new requirements and procedures.",
  "always_show_guidance": false,
  "guidance_answer_value": "enterprise",
  "guidance_operator": "equals"
}

Removing Conditions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
PATCH /api/checklists-admin-questions/{question_uuid}/
Content-Type: application/json

{
  "always_requires_review": false,
  "review_answer_value": [],
  "operator": "equals",
  "always_show_guidance": true,
  "guidance_answer_value": [],
  "guidance_operator": "equals"
}

API Response Examples for Review and Guidance

Question with Active Guidance (User View)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Will you be using cloud services?",
  "question_type": "boolean",
  "required": true,
  "user_guidance": "Since you're using cloud services, please ensure you review our cloud security checklist.",
  "existing_answer": {
    "uuid": "answer-uuid",
    "answer_data": true,
    "requires_review": false,
    "created": "2024-01-15T10:30:00Z"
  }
}

Question with Review Flag (Reviewer View)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "What type of data will you process?",
  "question_type": "multi_select",
  "required": true,
  "user_guidance": "You've selected sensitive data types. Additional security measures will be required.",
  "existing_answer": {
    "uuid": "answer-uuid",
    "answer_data": ["personal_data", "financial_data"],
    "requires_review": true,
    "created": "2024-01-15T10:30:00Z"
  },
  "operator": "in",
  "review_answer_value": ["personal_data", "financial_data", "health_data"],
  "always_requires_review": false
}

Completion Status with Review Summary

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "uuid": "completion-uuid",
  "is_completed": true,
  "completion_percentage": 100.0,
  "requires_review": true,
  "review_trigger_summary": [
    {
      "question": "What type of data will you process?",
      "answer": ["personal_data", "financial_data"],
      "trigger_value": ["personal_data", "financial_data", "health_data"],
      "operator": "in"
    },
    {
      "question": "Will your application process payments?",
      "answer": true,
      "trigger_value": true,
      "operator": "equals"
    }
  ],
  "reviewed_by": null,
  "reviewed_at": null,
  "review_notes": ""
}

Best Practices

Review Trigger Design

  1. Clear Criteria: Use specific, unambiguous trigger conditions
  2. Risk-Based: Focus triggers on high-risk or compliance-critical answers
  3. Consistent Operators: Use the same operators across similar question types
  4. Documentation: Include internal notes about why specific answers trigger reviews

User Guidance Best Practices

  1. Actionable: Provide specific next steps, not just information
  2. Contextual: Tailor guidance to the specific answer given
  3. Timely: Show guidance when users need it most
  4. Resource Links: Include references to relevant documentation or contacts

Workflow Integration

  1. Progressive Disclosure: Use conditional visibility with guidance to reduce cognitive load
  2. Layered Validation: Combine client-side guidance with server-side review triggers
  3. Clear Feedback: Ensure users understand when answers will be reviewed
  4. Review Efficiency: Design triggers to minimize false positives for reviewers

Permission System

Access control is implemented through:

  • Staff Administration: Direct checklist management restricted to staff users
  • App-level Integration: Checklist access controlled via host application permissions
  • Mixin-based Permissions: Apps define their own permission requirements for checklist actions
  • Review Segregation: Separate permissions for users vs reviewers to hide sensitive review logic

Validation and Data Integrity

The system includes comprehensive validation:

  • Answer Type Validation: Ensures answers match expected question types
  • Required Question Enforcement: Prevents submission of incomplete required questions
  • UUID Validation: Proper UUID format checking for references
  • Circular Dependency Prevention: Automatic detection of invalid dependency chains

Integration with Waldur Apps

The checklist system integrates with various Waldur applications:

  • Generic Foreign Key System: Can be attached to any Django model (proposals, projects, resources, etc.)
  • ViewSet Mixins: Easy integration through UserChecklistMixin and ReviewerChecklistMixin
  • Flexible Completion Tracking: Each integration controls its own completion lifecycle
  • Permission Delegation: Host applications define appropriate permission checks

Usage Patterns

Basic Integration Flow

  1. Admin Setup: Staff creates checklists with questions, dependencies, and review triggers
  2. App Integration: Host app (e.g., proposals) creates ChecklistCompletion objects linking checklists to domain objects
  3. User Interaction: End users access checklists through app-specific endpoints using UserChecklistMixin
  4. Answer Submission: Users submit answers, triggering automatic completion status updates
  5. Review Process: Reviewers access full checklist information through ReviewerChecklistMixin
  6. Completion Tracking: Host apps monitor completion status and take appropriate actions

Example Integration (Proposals)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# proposals/models.py
class Proposal(models.Model):
    # ... other fields
    checklist_completion = models.OneToOneField(
        ChecklistCompletion,
        on_delete=models.CASCADE,
        null=True, blank=True
    )

# proposals/views.py
class ProposalViewSet(UserChecklistMixin, ReviewerChecklistMixin, ActionsViewSet):
    # User permissions
    checklist_permissions = [permission_factory(PermissionEnum.MANAGE_PROPOSAL)]
    submit_answers_permissions = [permission_factory(PermissionEnum.MANAGE_PROPOSAL)]

    # Reviewer permissions
    checklist_review_permissions = [permission_factory(PermissionEnum.REVIEW_PROPOSALS)]

Technical Implementation

The module follows Waldur's standard architecture patterns:

  • Django Models: Standard ORM with mixins (UuidMixin, DescribableMixin, TimeStampedModel)
  • Generic Foreign Keys: Flexible linking to any Django model through ChecklistCompletion
  • DRF Serializers: REST API serialization with context-aware field exposure
  • ViewSet Mixins: Reusable mixins for consistent integration across applications
  • Admin-Only Core APIs: Direct checklist management restricted to staff
  • Permissions: Delegated to host applications with mixin-based controls
  • Filtering: Advanced filtering for admin interfaces
  • Validation: Answer validation based on question types and business rules

Architecture Principles

  • Separation of Concerns: Core checklist logic separated from app-specific business logic
  • Flexible Integration: Generic foreign keys allow attachment to any model
  • Security by Design: Review logic hidden from users, exposed only to authorized reviewers
  • Extensible Question Types: Support for multiple answer formats with validation
  • Dependency Management: Sophisticated conditional logic with circular prevention

The system is designed for scalability and extensibility, supporting complex compliance scenarios while maintaining ease of integration for host applications.

STOMP-Based Event Notification System

System Overview

The STOMP-based event notification system allows Waldur to communicate changes to resources, orders, and user roles to the waldur-site-agent that runs on a remote cluster. This eliminates the need for constant polling and enables immediate reactions to events.

The key components include:

  1. STOMP Publisher (Waldur side): Located in the waldur_core/logging/utils.py file, this component publishes messages to STOMP queues when specific events occur.

  2. Event Subscription Service: Manages subscriptions to events by creating unique topics for each type of notification. Related file: event subscription management via API: waldur_core/logging/views.py

  3. STOMP Consumer (Agent side): The waldur-site-agent running on the resource provider's infrastructure that subscribes to these topics and processes incoming messages. Related files:

  4. Event subscription registration: waldur_site_agent/event_processing/utils.py
  5. STOMP message handlers: waldur_site_agent/event_processing/handlers.py
  6. STOMP listener: waldur_site_agent/event_processing/listener.py

Event Flow

  1. An event occurs in Waldur (e.g., a new order is created, a user role changes, or a resource is updated)
  2. Waldur publishes a message to the appropriate STOMP queue(s)
  3. The site agent receives the message and processes it based on the event type
  4. The agent communicates with the backend (e.g., SLURM) to execute the necessary actions

Message Types

The system handles three primary types of events:

  1. Order Messages: Notifications about marketplace orders (create, update, terminate)
  2. User Role Messages: Changes to user permissions in projects
  3. Resource Messages: Updates to resource configuration or status

Implementation Details

Publishing Messages (Waldur Side)

When events like order creation occur, Waldur prepares and publishes STOMP messages: code link

These messages are then sent via: publish_stomp_messages

Subscription Management (Agent Side)

The EventSubscriptionManager class handles creation of event subscriptions and setup of STOMP consumers:

Message Processing (Agent Side)

When a message arrives, it's routed to the appropriate handler based on the event type:

Technical Components

  1. WebSocket Transport: The system uses STOMP over WebSockets for communication
  2. TLS Security: Connections can be secured with TLS
  3. User Authentication: Each subscription has its own credentials and permissions in RabbitMQ
  4. Queue Structure: Queue names follow the pattern /queue/subscription_{subscription_uuid}_offering_{offering_uuid}_{affected_object}

Error Handling and Resilience

The system includes:

  • Graceful connection handling
  • Signal handlers for proper shutdown
  • Retry mechanisms for order processing
  • Error logging and optional Sentry integration

Benefits of the STOMP Approach

  1. Real-time Processing: Actions are triggered immediately when events occur
  2. Reduced Network Traffic: No constant polling needed
  3. Decoupling: The agent doesn't need direct access to Waldur's database
  4. Scalability: Multiple agents can subscribe to different events
  5. Reliability: The STOMP protocol provides queue persistency to ensure message delivery and different acknowledgement options on the agent side

This event-driven architecture significantly improves the responsiveness and efficiency of the order processing system compared to traditional polling approaches.

Invitations

The invitation system in Waldur provides a mechanism for inviting users to join organizations (customers), projects, or other scoped resources with specific roles. The system supports two main invitation types: individual invitations and group invitations, with different workflows and approval mechanisms.

Architecture Overview

The invitation system is built around three core models in waldur_core.users.models:

  • BaseInvitation: Abstract base class providing common fields and functionality
  • Invitation: Individual invitations for specific users with email-based delivery
  • GroupInvitation: Template-based invitations that can be used by multiple users matching specific criteria
  • PermissionRequest: Approval workflow for group invitation requests

Invitation Types

Individual Invitations

Individual invitations are sent to specific email addresses and provide a direct mechanism to grant users access to resources.

Key Features

  • Email-based delivery: Invitations are sent to specific email addresses
  • Civil number validation: Optional civil number matching for enhanced security
  • State management: Full lifecycle tracking with states like pending, accepted, canceled, expired
  • Execution tracking: Background processing with error handling and retry capabilities
  • Expiration handling: Automatic expiration based on configurable timeouts
  • Webhook support: External system integration for invitation delivery

State Flow

stateDiagram-v2
    [*] --> PENDING: Create invitation
    [*] --> REQUESTED: Staff approval required
    [*] --> PENDING_PROJECT: Project not active yet

    REQUESTED --> PENDING: Staff approves
    REQUESTED --> REJECTED: Staff rejects

    PENDING_PROJECT --> PENDING: Project becomes active

    PENDING --> ACCEPTED: User accepts
    PENDING --> CANCELED: Creator cancels
    PENDING --> EXPIRED: Timeout reached

    CANCELED --> PENDING: Resend invitation
    EXPIRED --> PENDING: Resend invitation

    ACCEPTED --> [*]
    REJECTED --> [*]

Group Invitations

Group invitations provide template-based access that multiple users can request to join, with an approval workflow. They support both private invitations (visible only to authenticated users with appropriate permissions) and public invitations (visible to all users including unauthenticated ones).

Key Features

  • Pattern-based matching: Users can request access if they match email patterns or affiliations
  • Approval workflow: Requests go through a review process before granting access
  • Project creation option: Can automatically create projects instead of granting customer-level access
  • Role mapping: Support for different roles at customer and project levels
  • Template-based naming: Configurable project name templates for auto-created projects
  • Public visibility: Public invitations can be viewed and requested by unauthenticated users

Workflow

sequenceDiagram
    participant U as User
    participant GI as GroupInvitation
    participant PR as PermissionRequest
    participant A as Approver
    participant S as System

    U->>GI: Submit request
    GI->>PR: Create PermissionRequest
    PR->>A: Notify approvers
    A->>PR: Approve/Reject
    alt Approved & auto_create_project
      PR->>S: Create project
      S->>U: Grant project permission
    else Approved & normal
      PR->>S: Grant scope permission
    end
    PR->>U: Notify result

Public Group Invitations

Public group invitations are a special type of group invitation that can be viewed and requested by unauthenticated users. They are designed for open enrollment scenarios where organizations want to allow external users to request access to projects.

Key Characteristics
  • Unauthenticated visibility: Listed in public API endpoints without authentication
  • Staff-only creation: Only staff users can create and manage public invitations
  • Project-level access only: Public invitations can only grant project-level roles, not customer-level roles
  • Automatic project creation: All public invitations must use the auto-create project feature
  • Enhanced security: Authentication is still required for submitting actual access requests
Constraints and Validation
  1. Staff authorization: Only is_staff=True users can create public group invitations
  2. Auto-creation required: Public invitations must have auto_create_project=True
  3. Project roles only: Public invitations can only use roles starting with "PROJECT." (e.g., PROJECT.MANAGER, PROJECT.ADMIN)
  4. No customer-level access: Cannot grant customer-level roles like CUSTOMER.OWNER or CUSTOMER.SUPPORT
Use Cases
  • Open research projects: Universities allowing external researchers to request project access
  • Community initiatives: Organizations providing project spaces for community members
  • Partner collaborations: Companies offering project access to external partners
  • Educational platforms: Schools providing project environments for students

API Endpoints

Individual Invitations (/api/user-invitations/)

  • POST /api/user-invitations/ - Create invitation
  • GET /api/user-invitations/ - List invitations
  • GET /api/user-invitations/{uuid}/ - Retrieve invitation details
  • POST /api/user-invitations/{uuid}/send/ - Resend invitation
  • POST /api/user-invitations/{uuid}/cancel/ - Cancel invitation
  • POST /api/user-invitations/{uuid}/accept/ - Accept invitation (authenticated)
  • POST /api/user-invitations/{uuid}/delete/ - Delete invitation (staff only)
  • POST /api/user-invitations/approve/ - Approve invitation (token-based)
  • POST /api/user-invitations/reject/ - Reject invitation (token-based)
  • POST /api/user-invitations/{uuid}/check/ - Check invitation validity (unauthenticated)
  • GET /api/user-invitations/{uuid}/details/ - Get invitation details for display

Group Invitations (/api/user-group-invitations/)

  • POST /api/user-group-invitations/ - Create group invitation (authentication required)
  • GET /api/user-group-invitations/ - List group invitations (public invitations visible without authentication)
  • GET /api/user-group-invitations/{uuid}/ - Retrieve group invitation (public invitations accessible without authentication)
  • POST /api/user-group-invitations/{uuid}/cancel/ - Cancel group invitation (authentication required)
  • POST /api/user-group-invitations/{uuid}/submit_request/ - Submit access request (authentication required)
  • GET /api/user-group-invitations/{uuid}/projects/ - List available projects (authentication required)

Permission Requests (/api/user-permission-requests/)

  • GET /api/user-permission-requests/ - List permission requests
  • GET /api/user-permission-requests/{uuid}/ - Retrieve permission request
  • POST /api/user-permission-requests/{uuid}/approve/ - Approve request
  • POST /api/user-permission-requests/{uuid}/reject/ - Reject request

Model Fields and Relationships

BaseInvitation (Abstract)

1
2
3
4
5
6
7
class BaseInvitation:
    created_by: ForeignKey[User]      # Who created the invitation
    customer: ForeignKey[Customer]    # Associated customer (computed from scope)
    role: ForeignKey[Role]           # Role to be granted
    scope: GenericForeignKey         # Target scope (customer, project, etc.)
    created: DateTimeField           # Creation timestamp
    uuid: UUIDField                  # Unique identifier

Invitation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
class Invitation(BaseInvitation):
    # State management
    state: CharField                 # Current invitation state
    execution_state: FSMField        # Background processing state

    # User identification
    email: EmailField               # Target email address
    civil_number: CharField         # Optional civil number for validation

    # User details (copied from invitation)
    full_name: CharField
    native_name: CharField
    phone_number: CharField
    organization: CharField
    job_title: CharField

    # Processing
    approved_by: ForeignKey[User]   # Staff member who approved
    error_message: TextField        # Processing errors
    extra_invitation_text: TextField # Custom message (max 250 chars)

GroupInvitation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
class GroupInvitation(BaseInvitation):
    is_active: BooleanField         # Whether invitation is active
    is_public: BooleanField         # Allow unauthenticated users to see invitation

    # User pattern matching
    user_email_patterns: JSONField  # Email patterns for matching users
    user_affiliations: JSONField    # Affiliation patterns

    # Project creation alternative
    auto_create_project: BooleanField      # Create project instead of customer role
    project_role: ForeignKey[Role]         # Role for auto-created project
    project_name_template: CharField       # Template for project naming

PermissionRequest

1
2
3
4
5
6
7
8
9
class PermissionRequest(ReviewMixin):
    invitation: ForeignKey[GroupInvitation]  # Associated group invitation
    created_by: ForeignKey[User]            # User requesting access

    # Review workflow (inherited from ReviewMixin)
    state: CharField                        # pending, approved, rejected
    reviewed_by: ForeignKey[User]
    reviewed_at: DateTimeField
    review_comment: TextField

Permission System Integration

Access Control

Invitation management permissions are controlled through:

  1. Staff privileges: Staff users can manage all invitations
  2. Scope-based permissions: Users with CREATE permissions on scopes can manage invitations
  3. Customer-level access: Customer owners can manage invitations for their resources
  4. Hierarchical permissions: Customer permissions apply to contained projects

Permission Checks

The system uses can_manage_invitation_with() utility (src/waldur_core/users/utils.py:179) for authorization:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
def can_manage_invitation_with(request, scope):
    if request.user.is_staff:
        return True

    permission = get_create_permission(scope)
    if has_permission(request, permission, scope):
        return True

    customer = get_customer(scope)
    if has_permission(request, permission, customer):
        return True

Filtering and Visibility

  • InvitationFilterBackend: Filters invitations based on user permissions
  • GroupInvitationFilterBackend: Controls group invitation visibility, allows public invitations for unauthenticated users
  • PendingInvitationFilter: Filters invitations user can accept
  • VisibleInvitationFilter: Controls invitation detail visibility

Background Processing

Celery Tasks

The invitation system uses several background tasks (src/waldur_core/users/tasks.py):

Core Processing Tasks

  • process_invitation: Main processing entry point
  • send_invitation_created: Send invitation emails/webhooks
  • get_or_create_user: Create user accounts for invitations
  • send_invitation_requested: Notify staff of invitation requests

Maintenance Tasks

  • cancel_expired_invitations: Clean up expired invitations
  • cancel_expired_group_invitations: Clean up expired group invitations
  • process_pending_project_invitations: Activate invitations for started projects
  • send_reminder_for_pending_invitations: Send reminder emails

Notification Tasks

  • send_invitation_rejected: Notify creators of rejections
  • send_mail_notification_about_permission_request_has_been_submitted: Notify approvers

Execution States

Individual invitations track background processing with FSM states:

  • SCHEDULED: Initial state, queued for processing
  • PROCESSING: Currently being processed
  • OK: Successfully processed
  • ERRED: Processing failed with error details

Error Handling

The system provides robust error tracking:

  • Error messages: Human-readable error descriptions
  • Error tracebacks: Full stack traces for debugging
  • Retry mechanisms: Failed invitations can be resent
  • Webhook failover: Falls back to email if webhooks fail

Configuration Options

Core Settings (WALDUR_CORE)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Invitation lifecycle
INVITATION_LIFETIME = timedelta(weeks=1)        # Individual invitation expiration
GROUP_INVITATION_LIFETIME = timedelta(weeks=4)  # Group invitation expiration
INVITATION_MAX_AGE = 60 * 60 * 24 * 7          # Token validity period

# User creation
INVITATION_CREATE_MISSING_USER = False         # Auto-create user accounts
ONLY_STAFF_CAN_INVITE_USERS = False           # Require staff approval

# Validation
VALIDATE_INVITATION_EMAIL = False              # Strict email matching

Constance Settings

1
2
3
# Runtime configuration
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION = True   # Enforce email matching
INVITATION_DISABLE_MULTIPLE_ROLES = False         # Prevent multiple roles per user

Webhook Integration

1
2
3
4
5
6
# External system integration
INVITATION_USE_WEBHOOKS = False                   # Enable webhook delivery
INVITATION_WEBHOOK_URL = ""                       # Target webhook URL
INVITATION_WEBHOOK_TOKEN_URL = ""                 # OAuth token endpoint
INVITATION_WEBHOOK_TOKEN_CLIENT_ID = ""           # OAuth client ID
INVITATION_WEBHOOK_TOKEN_SECRET = ""              # OAuth client secret

Email Templates

The system uses several email templates (waldur_core/users/templates/):

  • invitation_created - New invitation notification
  • invitation_requested - Staff approval request
  • invitation_rejected - Rejection notification
  • invitation_expired - Expiration notification
  • invitation_approved - Auto-created user credentials
  • permission_request_submitted - Permission request notification

Advanced Features

Project Auto-Creation

Group invitations can automatically create projects instead of granting customer-level access:

1
2
3
4
5
6
7
8
9
# Configuration
auto_create_project = True
project_role = ProjectRole.MANAGER
project_name_template = "{user.full_name} Project"

# On approval, creates:
# 1. New project with resolved name
# 2. Project-level role assignment
# 3. Proper permission hierarchy

Pattern Matching

Group invitations support sophisticated user matching:

1
2
3
4
5
6
7
# Email patterns
user_email_patterns = ["*@company.com", "*@university.edu"]

# Affiliation patterns
user_affiliations = ["ACME Corp", "State University"]

# Validation logic in GroupInvitation.get_objects_by_user_patterns()

Token-Based Security

Staff approval uses cryptographically signed tokens:

1
2
3
4
5
6
# Token format: {user_uuid}.{invitation_uuid}
signer = TimestampSigner()
token = signer.sign(f"{user.uuid.hex}.{invitation.uuid.hex}")

# Tokens expire based on INVITATION_MAX_AGE setting
# Invalid tokens raise ValidationError with descriptive messages

Security Considerations

Civil Number Validation

When civil_number is provided:

  • Only users with matching civil numbers can accept invitations
  • Provides additional security layer for sensitive resources
  • Empty civil numbers allow any user to accept

Email Validation

Multiple levels of email validation:

  1. Loose matching (default): Case-insensitive email comparison
  2. Strict validation: Exact email matching when ENABLE_STRICT_CHECK_ACCEPTING_INVITATION=True
  3. Pattern matching: Group invitations validate against email patterns

Token Security

  • Cryptographic signing: Uses Django's TimestampSigner
  • Time-based expiration: Tokens expire after configurable period
  • Payload validation: Validates UUID formats and user/invitation existence
  • State verification: Ensures invitations are in correct state for operation

Permission Isolation

  • Scope-based filtering: Users only see invitations they can manage
  • Role validation: Ensures roles match scope content types, with additional constraints for public invitations
  • Customer isolation: Prevents cross-customer invitation access
  • Public invitation constraints: Public invitations restricted to project-level roles only

Best Practices

Creating Invitations

  1. Validate scope-role compatibility before creating invitations
  2. Set appropriate expiration times based on use case sensitivity
  3. Use civil numbers for high-security invitations
  4. Include helpful extra_invitation_text for user context

Group Invitation Setup

  1. Design clear email patterns that match intended user base
  2. Choose appropriate role mappings for auto-created projects
  3. Set meaningful project name templates for clarity
  4. Configure proper approval workflows with designated approvers

Public Invitation Management

  1. Restrict to staff users only - Only allow trusted staff to create public invitations
  2. Use project-level roles exclusively - Never grant customer-level access through public invitations
  3. Design clear project naming - Use descriptive templates since multiple projects may be created
  4. Monitor request volume - Public invitations may generate high volumes of access requests
  5. Set up proper approval processes - Ensure adequate staffing to handle public invitation approvals

Error Handling

  1. Monitor execution states for processing failures
  2. Set up alerts for invitation processing errors
  3. Provide clear error messages to users and administrators
  4. Implement retry strategies for transient failures

Performance Optimization

  1. Use bulk operations for large invitation batches
  2. Index frequently queried fields (email, state, customer)
  3. Archive old invitations to prevent table bloat
  4. Monitor background task queues for processing bottlenecks

Troubleshooting

Common Issues

  1. Invitations stuck in PROCESSING state
  2. Check Celery task processing
  3. Review error messages in invitation records

  4. Verify SMTP/webhook configuration

  5. Users can't accept invitations

  6. Verify email matching settings
  7. Check civil number requirements

  8. Confirm invitation hasn't expired

  9. Permission denied errors

  10. Validate user has CREATE permissions on scope
  11. Check customer-level permissions for hierarchical access

  12. Confirm role is compatible with scope type

  13. Group invitation requests not working

  14. Verify email patterns match user addresses
  15. Check affiliation matching logic
  16. Confirm invitation is still active

Debugging Tools

  1. Admin interface: View invitation details and states
  2. Celery monitoring: Track background task execution
  3. Logging: Enable debug logging for invitation processing
  4. API introspection: Use /api/user-invitations/{uuid}/details/ for status checking

Integration Examples

Basic Individual Invitation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Create invitation
invitation = Invitation.objects.create(
    email="user@example.com",
    scope=customer,
    role=CustomerRole.OWNER,
    created_by=current_user,
    extra_invitation_text="Welcome to our platform!"
)

# Process in background
process_invitation.delay(invitation.uuid.hex, sender_name)

Group Invitation with Auto-Project

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Create group invitation
group_invitation = GroupInvitation.objects.create(
    scope=customer,
    role=CustomerRole.OWNER,
    auto_create_project=True,
    project_role=ProjectRole.MANAGER,
    project_name_template="{user.full_name}'s Research Project",
    user_email_patterns=["*@university.edu"],
    created_by=admin_user
)

# Users can submit requests that create projects on approval

Public Group Invitation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Create public group invitation (staff only)
public_invitation = GroupInvitation.objects.create(
    scope=customer,
    role=ProjectRole.MANAGER,  # Must be project-level role
    is_public=True,            # Makes it visible to unauthenticated users
    auto_create_project=True,  # Required for public invitations
    project_role=ProjectRole.MANAGER,
    project_name_template="{user.full_name} Research Project",
    user_email_patterns=["*@university.edu", "*@research.org"],
    created_by=staff_user      # Must be staff user
)

# Unauthenticated users can list and view this invitation
# Authentication is required only for submitting actual requests

Webhook Integration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Configure webhook delivery
settings.WALDUR_CORE.update({
    'INVITATION_USE_WEBHOOKS': True,
    'INVITATION_WEBHOOK_URL': 'https://external-system.com/invitations/',
    'INVITATION_WEBHOOK_TOKEN_URL': 'https://auth.external-system.com/token',
    'INVITATION_WEBHOOK_TOKEN_CLIENT_ID': 'waldur-client',
    'INVITATION_WEBHOOK_TOKEN_SECRET': 'secret-key',
})

# Invitations will be posted to external system instead of email

This invitation system provides flexible, secure, and scalable user onboarding capabilities that integrate seamlessly with Waldur's permission and organizational structure.

Event logging

Event log entries is something an end user will see. In order to improve user experience the messages should be written in a consistent way.

Here are the guidelines for writing good log events.

  • Use present perfect passive for the message.

Right: Environment %s has been created.

Wrong: Environment %s was created.

  • Build a proper sentence: start with a capital letter, end with a period.

Right: Environment %s has been created.

Wrong: environment %s has been created

  • Include entity names into the message string.

Right: User %s has gained role of %s in project %s.

Wrong: User has gained role in project.

  • Don't include too many details into the message string.

Right: Environment %s has been updated.

Wrong: Environment has been updated with name: %s, description: %s.

  • Use the name of an entity instead of its __str__.

Right: event_logger.info('Environment %s has been updated.', env.name)

Wrong: event_logger.info('Environment %s has been updated.', env)

  • Don't put quotes around names or entity types.

Right: Environment %s has been created.

Wrong: Environment "%s" has been created.

  • Don't capitalize entity types.

Right: User %s has gained role of %s in project %s.

Wrong: User %s has gained Role of %s in Project %s.

  • For actions that require background processing log both start of the process and its outcome.

Success flow:

  1. log Environment %s creation has been started. within HTTP request handler;

  2. log Environment %s has been created. at the end of background task.

Failure flow:

  1. log Environment %s creation has been started. within HTTP request handler;

  2. log Environment %s creation has failed. at the end of background task.

  3. For actions that can be processed within HTTP request handler log only success.

Success flow:

log User %s has been created. at the end of HTTP request handler.

Failure flow:

don't log anything, since most of the errors that could happen here are validation errors that would be corrected by user and then resubmitted.

Managed entities

Overview

Managed entities are entities for which Waldur's database is considered an authoritative source of information. By means of REST API a user defines the desired state of the entities. Waldur's jobs are then executed to make the backend (OpenStack, JIRA, etc) reflect the desired state as close as possible.

Since making changes to a backend can take a long time, they are done in background tasks.

Here's a proper way to deal with managed entities:

  • within the scope of REST API request:
  • introduce the change (create, delete or edit an entity) to the Waldur's database;
  • schedule a background job passing instance id as a parameter;

  • return a positive HTTP response to the caller.

  • within the scope of background job:

  • fetch the entity being changed by its instance id;

  • make sure that it is in a proper state (e.g. not being updated by another background job);
  • transactionally update the its state to reflect that it is being updated;
  • perform necessary calls to backend to synchronize changes from Waldur's database to that backend;
  • transactionally update its state to reflect that it not being updated anymore.

Using the above flow makes it possible for user to get immediate feedback from an initial REST API call and then query state changes of the entity.

Managed entities operations flow

  1. View receives request for entity change.

  2. If request contains any data - view passes request to serializer for validation.

  3. View extracts operations specific information from validated data and saves entity via serializer.

  4. View starts executor with saved instance and operation specific information as input.

  5. Executor handles entity states checks and transition.

  6. Executor schedules celery tasks to perform asynchronous operations.

  7. View returns response.

  8. Tasks asynchronously call backend methods to perform required operation.

  9. Callback tasks changes instance state after backend method execution.

Simplified schema of operations flow

View ---> Serializer ---> View ---> Executor ---> Tasks ---> Backend

Waldur Marketplace Module

The Waldur marketplace module provides a unified service catalog with configurable billing patterns, approval workflows, and comprehensive service orchestration. It serves as the central hub for service provisioning, order management, and billing across diverse service types.

Architecture Overview

The marketplace follows a Service Catalog → Order → Resource → Billing architecture that abstracts service complexity while providing flexible customization:

graph TB
    subgraph "Service Catalog"
        SP[ServiceProvider] --> O[Offering]
        O --> OC[OfferingComponent]
        O --> P[Plan]
        P --> PC[PlanComponent]
    end

    subgraph "Order Processing"
        Order --> Processor[OrderProcessor]
        Processor --> Resource
        Resource --> Endpoint[ResourceAccessEndpoint]
    end

    subgraph "Billing"
        PC --> CU[ComponentUsage]
        Resource --> CU
        CU --> Invoice[Billing System]
    end

    Order --> Resource
    O --> Order
    P --> Order

Core Models

  • ServiceProvider: Organizations offering services through the marketplace
  • Offering: Service definitions with pricing, components, and configuration
  • OfferingComponent: Individual billable items (CPU, storage, support hours, etc.)
  • Plan: Service packages with specific pricing and resource allocations
  • Order: Purchase requests that trigger resource provisioning
  • Resource: Provisioned service instances with lifecycle management

Order Lifecycle and State Management

Order States

Orders progress through a carefully managed state machine with approval workflows:

stateDiagram-v2
    [*] --> PENDING_CONSUMER : Order created

    PENDING_CONSUMER --> PENDING_PROVIDER : Consumer approves
    PENDING_CONSUMER --> CANCELED : Consumer cancels
    PENDING_CONSUMER --> REJECTED : Consumer rejects

    PENDING_PROVIDER --> PENDING_PROJECT : Provider approves
    PENDING_PROVIDER --> CANCELED : Provider cancels
    PENDING_PROVIDER --> REJECTED : Provider rejects

    PENDING_PROJECT --> EXECUTING : Project activated
    PENDING_PROJECT --> CANCELED : Project issues

    EXECUTING --> DONE : Processing complete
    EXECUTING --> ERRED : Processing failed

    DONE --> [*]
    ERRED --> [*]
    CANCELED --> [*]
    REJECTED --> [*]

State Descriptions

State Description Triggers
PENDING_CONSUMER Awaiting customer approval Order creation
PENDING_PROVIDER Awaiting service provider approval Consumer approval
PENDING_PROJECT Awaiting project activation Provider approval
EXECUTING Resource provisioning in progress Processor execution
DONE Order completed successfully Resource provisioning success
ERRED Order failed with errors Processing errors
CANCELED Order canceled by user/system User cancellation
REJECTED Order rejected by provider Provider rejection

Resource States

Resources maintain their own lifecycle independent of orders:

stateDiagram-v2
    [*] --> CREATING : Order approved

    CREATING --> OK : Provisioning success
    CREATING --> ERRED : Provisioning failed

    OK --> UPDATING : Update requested
    OK --> TERMINATING : Deletion requested

    UPDATING --> OK : Update success
    UPDATING --> ERRED : Update failed

    TERMINATING --> TERMINATED : Deletion success
    TERMINATING --> ERRED : Deletion failed

    ERRED --> OK : Error resolved
    ERRED --> UPDATING : Retry update
    ERRED --> TERMINATING : Force deletion

    TERMINATED --> [*]

Resource State Descriptions

State Description Operations Allowed
CREATING Resource being provisioned Monitor progress
OK Resource active and healthy Update, delete, use
UPDATING Resource being modified Monitor progress
TERMINATING Resource being deleted Monitor progress
TERMINATED Resource deleted Archive, billing
ERRED Resource in error state Retry, investigate, delete

Billing System

Billing Types

The marketplace supports five distinct billing patterns:

Type Use Case Example Billing Trigger
FIXED Monthly subscriptions, SaaS plans $50/month hosting Service provider sets price
USAGE Pay-as-you-consume $0.10/GB storage used Usage reports submitted
LIMIT Resource quotas with different periods $5/CPU core allocated monthly
$150/500GB quarterly storage		 User specifies limits
ONE_TIME Setup fees, licenses $100 installation Resource activation
ON_PLAN_SWITCH Plan change fees $25 upgrade fee Plan modifications

Component Architecture

Each offering consists of billable components with independent pricing:

graph LR
    subgraph "Offering: Cloud VM"
        C1[CPU Cores<br/>LIMIT billing]
        C2[RAM GB<br/>LIMIT billing]
        C3[Storage GB<br/>USAGE billing]
        C4[Network Traffic<br/>USAGE billing]
        C5[Management Fee<br/>FIXED billing]
    end

    subgraph "User Order"
        L1[4 CPU cores]
        L2[8 GB RAM]
        L3[Unlimited storage]
        L4[Unlimited network]
        L5[1x management]
    end

    C1 --> L1
    C2 --> L2
    C3 --> L3
    C4 --> L4
    C5 --> L5

Limit Periods

For USAGE and LIMIT billing types, components can have consumption limits with different billing cycles:

  • MONTHLY: Reset limits every month (e.g., 100 GB storage/month)
  • QUARTERLY: Reset limits every quarter (e.g., 300 GB storage/quarter)
  • ANNUAL: Reset limits yearly (e.g., 1000 CPU hours/year)
  • TOTAL: Lifetime limits (e.g., 10 TB total storage)

Quarterly Billing Implementation

The QUARTERLY limit period provides specialized billing logic for resources that need to be billed on a quarterly cycle:

Billing Schedule: Quarterly components are only processed during the first month of each quarter:

  • Q1: January (months 1-3)
  • Q2: April (months 4-6)
  • Q3: July (months 7-9)
  • Q4: October (months 10-12)

Billing Period Calculation: When quarterly billing is triggered, the system:

  1. Calculates the full quarter period (e.g., Q2: April 1 - June 30)
  2. Creates invoice items with quarterly billing periods instead of monthly
  3. Uses PER_QUARTER unit for quantity calculations
  4. Applies prorated billing for partial quarters when limits change

Quarter Period Utilities: The system provides utility functions for quarter calculations:

  • get_current_quarter(): Returns current quarter (1-4)
  • get_current_quarter_start(): Start of current quarter
  • get_current_quarter_end(): End of current quarter
  • get_quarter_start(date): Start of quarter for given date
  • get_quarter_end(date): End of quarter for given date
  • get_full_quarters(start, end): Calculate quarters between dates

Usage Examples:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Quarterly storage component
{
    "type": "storage",
    "billing_type": "LIMIT",
    "limit_period": "QUARTERLY",
    "price": 150.00  # $150 per quarter for allocated storage
}

# User sets 500GB quarterly limit
# Only billed in January, April, July, October
# Invoice period: Q2 (April 1 - June 30)
# Quantity calculated using PER_QUARTER unit

MarketplaceRegistrator QUARTERLY Logic

The MarketplaceRegistrator class implements sophisticated quarterly billing logic in the following methods:

should_process_quarterly_billing(date): Determines when quarterly billing should be processed

1
2
3
def should_process_quarterly_billing(cls, date):
    """Only process quarterly billing in Q1 (Jan), Q2 (Apr), Q3 (Jul), Q4 (Oct)"""
    return date.month in [1, 4, 7, 10]

get_quarterly_billing_period(date): Calculates the complete quarterly period

1
2
3
4
5
def get_quarterly_billing_period(cls, date):
    """Returns (quarter_start, quarter_end) for the quarter containing date"""
    quarter_start = core_utils.get_quarter_start(date)
    quarter_end = core_utils.get_quarter_end(date)
    return quarter_start, quarter_end

get_period_end_for_limit_period(limit_period): Returns appropriate period end

1
2
3
4
5
def get_period_end_for_limit_period(cls, limit_period):
    if limit_period == LimitPeriods.QUARTERLY:
        return core_utils.get_current_quarter_end()
    else:
        return get_current_month_end()  # Default for MONTH, ANNUAL, TOTAL

Invoice Item Creation: The registrator handles quarterly components differently:

  1. During _create_item():
  2. Skips processing in non-quarterly months for QUARTERLY components
  3. Uses full quarterly periods instead of monthly periods

  4. Creates invoice items spanning entire quarters

  5. During create_or_update_component_item():

  6. Uses quarterly billing periods for new QUARTERLY components

  7. Handles limit changes with appropriate quarter calculations

  8. Quantity Calculation:

  9. Uses PER_QUARTER unit from common.enums.Units
  10. Leverages get_full_quarters(start, end) for period calculations
  11. Supports prorated billing for partial quarterly periods

Limit Update Handling: When resource limits change for quarterly components:

  • Updates existing invoice items with new quarterly periods
  • Creates compensation items for limit decreases (negative unit_price)
  • Maintains detailed resource_limit_periods in invoice item details

This implementation ensures that quarterly billing:

  • Only occurs during appropriate months (January, April, July, October)
  • Covers full quarterly periods for accurate billing
  • Handles mid-quarter limit changes with proper prorating
  • Integrates seamlessly with the existing monthly billing infrastructure

Processor Architecture

Processors handle service-specific provisioning logic while maintaining consistent interfaces:

Base Processor Classes

1
2
3
4
5
6
7
8
class BaseOrderProcessor:
    def process_order(self, user):
        """Execute approved orders"""
        raise NotImplementedError()

    def validate_order(self, request):
        """Pre-submission validation"""
        raise NotImplementedError()

Processor Flow

sequenceDiagram
    participant U as User
    participant O as Order
    participant P as Processor
    participant B as Backend
    participant R as Resource

    U->>O: Create order
    O->>P: validate_order()

    Note over O: Approval workflow

    O->>P: process_order()
    P->>B: Provision resource
    B-->>P: Backend ID/metadata
    P->>R: Create resource
    P->>R: Set endpoints
    P-->>O: Processing complete

Realistic Service Examples

1. Cloud Infrastructure (OpenStack)

Service Type: Virtual private cloud with compute, storage, networking Billing Pattern: Limit-based quotas + usage-based consumption

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
class TenantCreateProcessor(CreateResourceProcessor):
    fields = ['name', 'description', 'user_username', 'subnet_cidr']

    def get_post_data(self):
        # Maps order limits to OpenStack quotas
        return {
            'quotas': {
                'vcpu': self.order.limits.get('cpu'),
                'ram': self.order.limits.get('ram') * 1024,
                'storage': self.order.limits.get('storage')
            }
        }

Components:

  • CPU cores (limit-based, monthly reset)
  • RAM GB (limit-based, monthly reset)
  • Storage GB (usage-based, pay per GB used)
  • Network traffic (usage-based, pay per GB transferred)

2. Managed Kubernetes (Rancher)

Service Type: Fully managed Kubernetes with infrastructure orchestration Billing Pattern: Aggregated billing across multiple resources

1
2
3
4
5
6
7
class ManagedRancherCreateProcessor(CreateResourceProcessor):
    def process_order(self, user):
        # Complex orchestration: projects, tenants, networking, security
        project = self.create_dedicated_project()
        tenants = self.create_multi_az_tenants()
        load_balancer = self.create_load_balancer()
        return self.create_rancher_cluster(project, tenants, load_balancer)

Components:

  • Worker node hours (usage-based)
  • Master node (fixed monthly)
  • Load balancer (fixed monthly)
  • Storage volumes (limit-based, total)
  • Management fee (fixed monthly)

3. HPC Compute Allocation (SLURM)

Service Type: High-performance computing resource allocation Billing Pattern: Time-limited resource quotas

1
2
3
4
5
6
class CreateAllocationProcessor(CreateResourceProcessor):
    def validate_order(self, request):
        # Validate against cluster capacity and user quotas
        cluster_capacity = self.get_cluster_capacity()
        if self.order.limits['cpu_hours'] > cluster_capacity.available:
            raise ValidationError("Insufficient cluster capacity")

Components:

  • CPU hours (limit-based, annual reset)
  • GPU hours (limit-based, annual reset)
  • Storage quota (limit-based, total)
  • Priority queue access (one-time fee)

4. Enterprise Software Licensing

Service Type: Enterprise software with quarterly billing cycles Billing Pattern: Quarterly licensing with flexible user limits

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
class EnterpriseLicenseProcessor(CreateResourceProcessor):
    def validate_order(self, request):
        # Validate license capacity and quarterly billing alignment
        if not self.should_process_quarterly_billing(timezone.now()):
            raise ValidationError("Enterprise licenses can only be ordered in quarterly periods")

    def create_component_item(self, source, plan_component, invoice, start, end):
        # Override to use quarterly periods for all license components
        quarterly_start, quarterly_end = self.get_quarterly_billing_period(start)
        super().create_component_item(source, plan_component, invoice,
                                    quarterly_start, quarterly_end)

Components:

  • User licenses (limit-based, quarterly reset)
  • Admin seats (limit-based, quarterly reset)
  • Support hours (limit-based, quarterly reset)
  • Implementation services (one-time fee)
  • Training licenses (usage-based, quarterly reporting)

Advanced Features

Resource Access Endpoints

Resources can expose multiple access points:

1
2
3
4
5
6
# In processor
endpoints = [
    {"name": "Web Console", "url": "https://console.example.com"},
    {"name": "SSH Access", "url": "ssh user@server.example.com"},
    {"name": "API Endpoint", "url": "https://api.example.com/v1"}
]

Backend Metadata

Processors can store service-specific metadata:

1
2
3
4
5
6
backend_metadata = {
    "cluster_id": "k8s-prod-001",
    "region": "us-west-2",
    "version": "1.28.0",
    "features": ["ingress", "storage", "monitoring"]
}

Approval Workflows

The marketplace implements intelligent approval workflows that automatically determine when manual approval is required based on order characteristics, user permissions, and offering configuration.

Order Approval Logic Flow

flowchart TD
    A[Order Created] --> B{Consumer Approval Required?}
    B -->|Yes| C[PENDING_CONSUMER]
    B -->|No| D{Project Start Date Set?}
    C --> E[Consumer Reviews] --> D
    D -->|Yes| F[PENDING_PROJECT]
    D -->|No| G{Provider Approval Required?}
    F --> H[Project Activated] --> G
    G -->|Yes| I[PENDING_PROVIDER]
    G -->|No| J[EXECUTING]
    I --> K[Provider Reviews] --> J
    J --> L[Order Processing]

Consumer Approval Rules

Consumer approval is skipped when any of these conditions are met:

Condition Requirements Implementation
Staff User Order created by staff user user.is_staff == True
Private Offering User has project-level approval permission has_permission(APPROVE_PRIVATE_ORDER, project)
Same Organization Auto-Approval Public offering with auto-approval enabled offering.shared && offering.customer == project.customer && auto_approve_in_service_provider_projects == True
Termination by Service Provider Service provider owner terminating resource order.type == TERMINATE && has_owner_access(user, offering.customer)
Project Permission User has order approval permission has_permission(APPROVE_ORDER, project)

Provider Approval Rules

Provider approval is skipped for specific offering types and conditions:

Offering Type Auto-Approval Logic
Basic Offerings Always require manual approval (BASIC_PLUGIN_NAME)
Site Agent Always require manual approval (SITE_AGENT_PLUGIN_NAME)
Remote Offerings Skip if: auto_approve_remote_orders OR user is service provider owner/manager
All Other Types Always skip approval (auto-approve)

Remote Offering Approval Logic

For remote marketplace offerings, approval is skipped when:

1
2
3
4
5
6
7
# Any of these conditions allows auto-approval:
auto_approve_remote_orders = offering.plugin_options.get("auto_approve_remote_orders", False)
user_is_service_provider_owner = has_owner_access(user, offering.customer)
user_is_service_provider_offering_manager = (
    has_service_manager_access(user, offering.customer) and
    offering.has_user(user)
)

Project Approval Rules

Project approval occurs when:

  • Project Start Date: Project has a future start_date set
  • Orders wait in PENDING_PROJECT state until project is activated
  • When start_date is cleared, pending orders automatically proceed

Approval Workflow Handler

The approval logic is implemented in notify_approvers_when_order_is_created handler:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
def notify_approvers_when_order_is_created(order):
    if order_should_not_be_reviewed_by_consumer(order):
        order.review_by_consumer(order.created_by)

        if order.project.start_date and order.project.start_date > now().date():
            order.state = OrderStates.PENDING_PROJECT
        elif order_should_not_be_reviewed_by_provider(order):
            order.set_state_executing()
            process_order_on_commit(order, order.created_by)
        else:
            order.state = OrderStates.PENDING_PROVIDER
            notify_provider_about_pending_order(order)
    else:
        notify_consumer_about_pending_order(order)

Notification System

The system automatically notifies relevant approvers:

  • Consumer Notifications: Project managers, customer owners with APPROVE_ORDER permission
  • Provider Notifications: Service provider staff, offering managers
  • Staff Notifications: Optional staff notifications via NOTIFY_STAFF_ABOUT_APPROVALS setting

Configuration Options

Approval behavior can be customized through offering plugin_options:

1
2
3
4
offering.plugin_options = {
    "auto_approve_in_service_provider_projects": True,  # Skip consumer approval for same org
    "auto_approve_remote_orders": True,                 # Skip provider approval for remote
}

This intelligent approval system ensures that:

  • Routine operations (staff actions, same-org requests) skip unnecessary approvals
  • High-risk operations (external requests, termination) require appropriate review
  • Complex workflows (remote offerings, delayed projects) handle edge cases gracefully
  • Notification fatigue is minimized through targeted approver selection

Error Handling and Rollback

1
2
3
4
5
6
7
8
9
def process_order(self, user):
    try:
        resource = self.provision_resource()
        self.configure_networking()
        self.setup_monitoring()
        return resource
    except Exception as e:
        self.rollback_changes()
        raise ValidationError(f"Provisioning failed: {e}")

Integration Patterns

Synchronous Processing

For simple, fast operations:

1
2
3
def process_order(self, user):
    resource = self.create_simple_resource()
    return True  # Immediate completion

Asynchronous Processing

For complex, long-running operations:

1
2
3
def process_order(self, user):
    self.schedule_provisioning_task()
    return False  # Async completion, callbacks handle state

External API Integration

1
2
3
4
def send_request(self, user):
    api_client = self.get_api_client()
    response = api_client.create_resource(self.get_post_data())
    return self.parse_response(response)

OfferingUser States and Management

OfferingUser represents a user account created for a specific marketplace offering. It supports a finite state machine (FSM) that tracks the lifecycle of user account creation, validation, and management.

States

OfferingUser has the following states:

State Description
CREATION_REQUESTED Initial state when user account creation is requested
CREATING Account is being created by the service provider
PENDING_ACCOUNT_LINKING Waiting for user to link their existing account
PENDING_ADDITIONAL_VALIDATION Requires additional validation from service provider
OK Account is active and ready to use
DELETION_REQUESTED Account deletion has been requested
DELETING Account is being deleted
DELETED Account has been successfully deleted
ERROR_CREATING An error occurred during account creation
ERROR_DELETING An error occurred during account deletion

State Transitions

stateDiagram-v2
    [*] --> CREATION_REQUESTED : Account requested

    CREATION_REQUESTED --> CREATING : begin_creating()
    CREATION_REQUESTED --> OK : set_ok()

    CREATING --> PENDING_ACCOUNT_LINKING : set_pending_account_linking()
    CREATING --> PENDING_ADDITIONAL_VALIDATION : set_pending_additional_validation()
    CREATING --> OK : set_ok()

    PENDING_ACCOUNT_LINKING --> OK : set_validation_complete()
    PENDING_ADDITIONAL_VALIDATION --> OK : set_validation_complete()

    OK --> DELETION_REQUESTED : request_deletion()

    DELETION_REQUESTED --> DELETING : set_deleting()
    DELETING --> DELETED : set_deleted()

    %% Error state transitions during creation flow
    CREATION_REQUESTED --> ERROR_CREATING : set_error_creating()
    CREATING --> ERROR_CREATING : set_error_creating()
    PENDING_ACCOUNT_LINKING --> ERROR_CREATING : set_error_creating()
    PENDING_ADDITIONAL_VALIDATION --> ERROR_CREATING : set_error_creating()

    %% Error state transitions during deletion flow
    DELETION_REQUESTED --> ERROR_DELETING : set_error_deleting()
    DELETING --> ERROR_DELETING : set_error_deleting()

    %% Recovery from error states
    ERROR_CREATING --> CREATING : begin_creating()
    ERROR_CREATING --> OK : set_ok()
    ERROR_CREATING --> PENDING_ACCOUNT_LINKING : set_pending_account_linking()
    ERROR_CREATING --> PENDING_ADDITIONAL_VALIDATION : set_pending_additional_validation()

    ERROR_DELETING --> DELETING : set_deleting()
    ERROR_DELETING --> OK : set_ok()

    %% Legacy error transitions (backward compatibility)
    CREATION_REQUESTED --> ERROR_CREATING : set_error() [legacy]
    CREATING --> ERROR_CREATING : set_error() [legacy]
    PENDING_ACCOUNT_LINKING --> ERROR_CREATING : set_error() [legacy]
    PENDING_ADDITIONAL_VALIDATION --> ERROR_CREATING : set_error() [legacy]
    OK --> ERROR_CREATING : set_error() [legacy]
    DELETION_REQUESTED --> ERROR_CREATING : set_error() [legacy]
    DELETING --> ERROR_CREATING : set_error() [legacy]

REST API Endpoints

State Transition Actions

All state transition endpoints require UPDATE_OFFERING_USER permission and are accessed via POST to the offering user detail endpoint with the action suffix.

Base URL: /api/marketplace-offering-users/{uuid}/

Set Pending Additional Validation

1
2
3
4
5
6
7
POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/
Content-Type: application/json

{
  "comment": "Additional documents required for validation",
  "comment_url": "https://docs.example.com/validation-requirements"
}

Valid transitions from: CREATING, ERROR_CREATING

Set Pending Account Linking

1
2
3
4
5
6
7
POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/
Content-Type: application/json

{
  "comment": "Please link your existing service account",
  "comment_url": "https://service.example.com/account-linking"
}

Valid transitions from: CREATING, ERROR_CREATING

Set Validation Complete

1
POST /api/marketplace-offering-users/{uuid}/set_validation_complete/

Valid transitions from: PENDING_ADDITIONAL_VALIDATION, PENDING_ACCOUNT_LINKING

Note: This action clears both the service_provider_comment and service_provider_comment_url fields.

Set Error Creating

1
POST /api/marketplace-offering-users/{uuid}/set_error_creating/

Valid transitions from: CREATION_REQUESTED, CREATING, PENDING_ACCOUNT_LINKING, PENDING_ADDITIONAL_VALIDATION

Sets the user account to error state during the creation process. Used when creation operations fail.

Set Error Deleting

1
POST /api/marketplace-offering-users/{uuid}/set_error_deleting/

Valid transitions from: DELETION_REQUESTED, DELETING

Sets the user account to error state during the deletion process. Used when deletion operations fail.

Begin Creating

1
POST /api/marketplace-offering-users/{uuid}/begin_creating/

Valid transitions from: CREATION_REQUESTED, ERROR_CREATING

Initiates the account creation process. Can be used to retry creation after an error.

Request Deletion

1
POST /api/marketplace-offering-users/{uuid}/request_deletion/

Valid transitions from: OK

Initiates the account deletion process. Moves the user from active status to deletion requested.

Set Deleting

1
POST /api/marketplace-offering-users/{uuid}/set_deleting/

Valid transitions from: DELETION_REQUESTED, ERROR_DELETING

Begins the account deletion process. Can be used to retry deletion after an error.

Set Deleted

1
POST /api/marketplace-offering-users/{uuid}/set_deleted/

Valid transitions from: DELETING

Marks the user account as successfully deleted. This is the final state for successful account deletion.

Service Provider Comment Management

Update Comments

Service providers can directly update comment fields without changing the user's state:

1
2
3
4
5
6
7
PATCH /api/marketplace-offering-users/{uuid}/update_comments/
Content-Type: application/json

{
  "service_provider_comment": "Updated instructions for account access",
  "service_provider_comment_url": "https://help.example.com/account-setup"
}

Permissions: Requires UPDATE_OFFERING_USER permission on the offering's customer.

Valid states: All states except DELETED

Both fields are optional - you can update just the comment, just the URL, or both.

OfferingUser Fields

When retrieving or updating OfferingUser objects, the following state-related fields are available:

  • state (string, read-only): Current state of the user account
  • service_provider_comment (string, read-only): Comment from service provider for pending states
  • service_provider_comment_url (string, read-only): Optional URL link for additional information or actions related to the service provider comment

Backward Compatibility

The system maintains backward compatibility with existing integrations:

Automatic State Transitions

  • Username Assignment: When a username is assigned to an OfferingUser (via API or set_offerings_username), the state automatically transitions to OK
  • Creation with Username: Creating an OfferingUser with a username immediately sets the state to OK

Legacy Endpoints

  • POST /api/marketplace-service-providers/{uuid}/set_offerings_username/ - Bulk username assignment that automatically transitions users to OK state

Legacy Error State Support

For backward compatibility with existing integrations:

  • set_error() method: The legacy set_error() method still exists and defaults to ERROR_CREATING state

New integrations should use the specific error states (ERROR_CREATING, ERROR_DELETING) for better error context.

Usage Examples

Service Provider Workflow

Standard Creation Flow

  1. Initial Creation: OfferingUser is created with state CREATION_REQUESTED
  2. Begin Processing: Transition to CREATING state
  3. Require Validation: If additional validation needed, transition to PENDING_ADDITIONAL_VALIDATION with explanatory comment and optional URL
  4. Complete Validation: Once validated, transition to OK state
  5. Account Ready: User can now access the service

Enhanced Workflow with Comment URLs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
# Step 1: Start creating the account
POST /api/marketplace-offering-users/abc123/begin_creating/

# Step 2: If validation is needed, provide instructions and a helpful URL
POST /api/marketplace-offering-users/abc123/set_pending_additional_validation/
{
  "comment": "Please upload your identity verification documents",
  "comment_url": "https://portal.example.com/identity-verification"
}

# Step 3: Service provider can update instructions without changing state
PATCH /api/marketplace-offering-users/abc123/update_comments/
{
  "service_provider_comment": "Documents received. Additional tax forms required.",
  "service_provider_comment_url": "https://portal.example.com/tax-forms"
}

# Step 4: When validation is complete, transition to OK (clears comment fields)
POST /api/marketplace-offering-users/abc123/set_validation_complete/

Error Handling and Recovery

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# If creation fails, set appropriate error state
POST /api/marketplace-offering-users/abc123/set_error_creating/

# To retry creation after fixing issues
POST /api/marketplace-offering-users/abc123/begin_creating/

# If deletion fails, set deletion error state
POST /api/marketplace-offering-users/abc123/set_error_deleting/

# To retry deletion after fixing issues
POST /api/marketplace-offering-users/abc123/set_deleting/

Account Deletion Workflow

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Step 1: Request account deletion (from OK state)
POST /api/marketplace-offering-users/abc123/request_deletion/

# Step 2: Begin deletion process (service provider starts deletion)
POST /api/marketplace-offering-users/abc123/set_deleting/

# Step 3: Mark as successfully deleted (final step)
POST /api/marketplace-offering-users/abc123/set_deleted/

# Alternative: If deletion encounters errors
POST /api/marketplace-offering-users/abc123/set_error_deleting/

# Then retry deletion process
POST /api/marketplace-offering-users/abc123/set_deleting/

Permissions

State transition endpoints use the permission_factory pattern with:

  • Permission: UPDATE_OFFERING_USER
  • Scope: ["offering.customer"] - User must have permission on the offering's customer

This means users need the UPDATE_OFFERING_USER permission on the customer that owns the offering associated with the OfferingUser.

Filtering OfferingUsers

The OfferingUser list endpoint supports filtering by state to help manage users across different lifecycle stages.

State Filtering

Filter OfferingUsers by their current state using the state query parameter:

1
2
GET /api/marketplace-offering-users/?state=Requested
GET /api/marketplace-offering-users/?state=Pending%20additional%20validation

Available State Filter Values

Filter Value State Constant Description
Requested CREATION_REQUESTED Users with account creation requested
Creating CREATING Users whose accounts are being created
Pending account linking PENDING_ACCOUNT_LINKING Users waiting to link existing accounts
Pending additional validation PENDING_ADDITIONAL_VALIDATION Users requiring additional validation
OK OK Users with active, ready-to-use accounts
Requested deletion DELETION_REQUESTED Users with deletion requested
Deleting DELETING Users whose accounts are being deleted
Deleted DELETED Users with successfully deleted accounts
Error creating ERROR_CREATING Users with errors during account creation
Error deleting ERROR_DELETING Users with errors during account deletion

Multiple State Filtering

Filter by multiple states simultaneously:

1
2
GET /api/marketplace-offering-users/?state=Requested&state=OK
GET /api/marketplace-offering-users/?state=Pending%20account%20linking&state=Pending%20additional%20validation

Combining with Other Filters

State filtering can be combined with other available filters:

1
2
3
4
5
6
7
8
# Filter by state and offering
GET /api/marketplace-offering-users/?state=OK&offering_uuid=123e4567-e89b-12d3-a456-426614174000

# Filter by state and user
GET /api/marketplace-offering-users/?state=Pending%20additional%20validation&user_uuid=456e7890-e89b-12d3-a456-426614174001

# Filter by state and provider
GET /api/marketplace-offering-users/?state=Creating&provider_uuid=789e0123-e89b-12d3-a456-426614174002

Error Handling

Invalid state values return HTTP 400 Bad Request:

1
2
GET /api/marketplace-offering-users/?state=InvalidState
# Returns: 400 Bad Request with error details

Other Available Filters

The OfferingUser list endpoint also supports these filters:

  • offering_uuid - Filter by offering UUID
  • user_uuid - Filter by user UUID
  • user_username - Filter by user's username (case-insensitive)
  • provider_uuid - Filter by service provider UUID
  • is_restricted - Filter by restriction status (boolean)
  • created_before / created_after - Filter by creation date
  • modified_before / modified_after - Filter by modification date
  • query - General search across offering name, username, and user names

Practical Filtering Examples

Here are common filtering scenarios for managing OfferingUsers:

Find Users Requiring Attention

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Get users needing validation or account linking
GET /api/marketplace-offering-users/?state=Pending%20additional%20validation&state=Pending%20account%20linking

# Get users in creation error state
GET /api/marketplace-offering-users/?state=Error%20creating

# Get users in deletion error state
GET /api/marketplace-offering-users/?state=Error%20deleting

# Get all users with any error state
GET /api/marketplace-offering-users/?state=Error%20creating&state=Error%20deleting

Monitor Service Provider Operations

1
2
3
4
5
# Track active creation processes for a specific provider
GET /api/marketplace-offering-users/?provider_uuid=123e4567&state=Creating

# Find successfully created accounts for a provider
GET /api/marketplace-offering-users/?provider_uuid=123e4567&state=OK

Audit and Reporting

1
2
3
4
5
# Get all deleted accounts for audit purposes
GET /api/marketplace-offering-users/?state=Deleted

# Find restricted users across all offerings
GET /api/marketplace-offering-users/?is_restricted=true

Events and Logging

State transitions generate:

  • Event logs: Recorded in the system event log for audit purposes
  • Application logs: Logged with user attribution for debugging and monitoring

Role-based Access Control (RBAC)

Overview

Waldur implements a comprehensive Role-Based Access Control (RBAC) system that determines what actions users can perform within the platform. The authorization system consists of three core components:

  1. Permissions - Unique strings that designate specific actions (e.g., OFFERING.CREATE, PROJECT.UPDATE)
  2. Roles - Named collections of permissions (e.g., CUSTOMER.OWNER, PROJECT.ADMIN)
  3. User Roles - Assignments linking users to roles within specific scopes

This functionality is implemented in the waldur_core.permissions application and provides fine-grained access control across all platform resources.

First thing to remember is to use PermissionEnum to define permissions instead of using plain string or standalone named constant, otherwise they would not be pushed to frontend.

1
2
3
4
5
# src/waldur_core/permissions/enums.py
class PermissionEnum(str, Enum):
  CREATE_OFFERING = 'OFFERING.CREATE'
  UPDATE_OFFERING = 'OFFERING.UPDATE'
  DELETE_OFFERING = 'OFFERING.DELETE'

Next, let's assign that permissions to role.

1
2
3
4
5
6
from waldur_core.permissions.fixtures import CustomerRole
from waldur_core.permissions.enums import PermissionEnum

CustomerRole.OWNER.add_permission(PermissionEnum.CREATE_OFFERING)
CustomerRole.OWNER.add_permission(PermissionEnum.UPDATE_OFFERING)
CustomerRole.OWNER.add_permission(PermissionEnum.DELETE_OFFERING)

Now, let's assign customer owner role to particular user and customer:

1
2
3
4
5
6
7
8
from django.contrib.auth import get_user_model
from waldur_core.structure.models import Customer

User = get_user_model()

user = User.objects.last()
customer = Customer.objects.last()
customer.add_user(user, CustomerRole.OWNER)

Finally, we can check whether user is allowed to create offering in particular organization.

1
2
3
4
from waldur_core.permissions.enums import PermissionEnum
from waldur_core.permissions.utils import has_permission

has_permission(request, PermissionEnum.CREATE_OFFERING, customer)

Please note that this function accepts not only customer, but also project and offering as a scope. Consider these models as authorization aggregates. Other models, such as resources and orders, should refer to these aggregates to perform authorization check. For example:

1
has_permission(request, PermissionEnum.SET_RESOURCE_USAGE, resource.offering.customer)

Core Concepts

Authorization Scopes

Waldur supports multiple authorization scopes, each representing a different organizational level:

Scope Type Model Description
Customer structure.Customer Organization-level permissions
Project structure.Project Project-level permissions within an organization
Offering marketplace.Offering Service offering permissions
Service Provider marketplace.ServiceProvider Provider-level permissions
Call proposal.Call Call for proposals permissions
Proposal proposal.Proposal Individual proposal permissions

System Roles

The platform includes several predefined system roles:

Customer Roles

  • CUSTOMER.OWNER - Full control over the organization
  • CUSTOMER.SUPPORT - Support access to organization resources
  • CUSTOMER.MANAGER - Management capabilities for service providers

Project Roles

  • PROJECT.ADMIN - Full project administration
  • PROJECT.MANAGER - Project management capabilities
  • PROJECT.MEMBER - Basic project member access

Offering Roles

  • OFFERING.MANAGER - Manage marketplace offerings

Call/Proposal Roles

  • CALL.REVIEWER - Review proposals in calls
  • CALL.MANAGER - Manage calls for proposals
  • PROPOSAL.MEMBER - Proposal team member
  • PROPOSAL.MANAGER - Proposal management

Role Features

Time-based Roles

Roles can have expiration times, allowing for temporary access:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_core.permissions.utils import add_user
from datetime import datetime, timedelta

expiration = datetime.now() + timedelta(days=30)
add_user(
    scope=project,
    user=user,
    role=ProjectRole.MEMBER,
    expiration_time=expiration
)

Role Revocation

Roles can be explicitly revoked before expiration:

1
2
3
4
5
6
7
8
from waldur_core.permissions.utils import delete_user

delete_user(
    scope=project,
    user=user,
    role=ProjectRole.MEMBER,
    current_user=request.user
)

Migration example

Previously we have relied on hard-coded roles, such as customer owner and project manager. Migration to dynamic roles on backend is relatively straightforward process. Consider the following example.

1
2
class ProviderPlanViewSet:
  archive_permissions = [structure_permissions.is_owner]

As you may see, we have relied on selectors with hard-coded roles. The main drawback of this approach is that it is very hard to inspect who can do what without reading all source code. And it is even hard to adjust this behaviour. Contrary to its name, by using dynamic roles we don't need to care much about roles though.

1
2
3
4
5
6
7
class ProviderPlanViewSet:
  archive_permissions = [
    permission_factory(
      PermissionEnum.ARCHIVE_OFFERING_PLAN,
      ['offering.customer'],
    )
  ]

Here we use permission_factory function which accepts permission string and list of paths to scopes, either customer, project or offering. It returns function which accepts request and raises an exception if user doesn't have specified permission in roles connected to current user and one of these scopes.

Permissions for viewing

Usually it is implemented filter backend, such as GenericRoleFilter, which in turn uses get_connected_customers and get_connected_projects function because customer and project are two main permission aggregates.

1
2
3
4
5
6
class PaymentProfileViewSet(core_views.ActionsViewSet):
    filter_backends = (
        structure_filters.GenericRoleFilter,
        DjangoFilterBackend,
        filters.PaymentProfileFilterBackend,
    )

Although this approach works fine for trivial use cases, often enough permission filtering logic is more involved and we implement get_queryset method instead.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
class OfferingUserGroupViewSet(core_views.ActionsViewSet):
  def get_queryset(self):
      queryset = super().get_queryset()
      current_user = self.request.user
      if current_user.is_staff or current_user.is_support:
        return queryset

      projects = get_connected_projects(current_user)
      customers = get_connected_customers(current_user)

      subquery = (
        Q(projects__customer__in=customers)
        | Q(offering__customer__in=customers)
        | Q(projects__in=projects)
      )
      return queryset.filter(subquery)

Permissions for object creation and update

Usually it is done in serializer's validate method.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
class RobotAccountSerializer:
  def validate(self, validated_data):
    request = self.context['request']
    if self.instance:
      permission = PermissionEnum.UPDATE_RESOURCE_ROBOT_ACCOUNT
    else:
      permission = PermissionEnum.CREATE_RESOURCE_ROBOT_ACCOUNT

    if not has_permission(request, permission, resource.offering.customer):
      raise PermissionDenied()

Permission Checking Utilities

Core Functions

has_permission(request, permission, scope)

Checks if a user has a specific permission in a given scope:

1
2
3
4
5
6
7
from waldur_core.permissions.utils import has_permission
from waldur_core.permissions.enums import PermissionEnum

# Check if user can create an offering
if has_permission(request, PermissionEnum.CREATE_OFFERING, customer):
    # User has permission
    pass

Note: Staff users automatically pass all permission checks.

permission_factory(permission, sources=None)

Creates a permission checker function for use in ViewSets:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_core.permissions.utils import permission_factory
from waldur_core.permissions.enums import PermissionEnum

class ResourceViewSet:
    update_permissions = [
        permission_factory(
            PermissionEnum.UPDATE_RESOURCE,
            ['offering.customer', 'project.customer']
        )
    ]

The sources parameter specifies paths to traverse from the current object to find the scope.

User and Role Management

Getting Users with Roles

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_core.permissions.utils import get_users, get_users_with_permission

# Get all users with any role in a project
users = get_users(project)

# Get users with specific role
managers = get_users(project, role_name='PROJECT.MANAGER')

# Get users with specific permission
can_update = get_users_with_permission(project, PermissionEnum.UPDATE_PROJECT)

Managing User Roles

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
from waldur_core.permissions.utils import add_user, update_user, delete_user, has_user

# Add user to role
permission = add_user(
    scope=project,
    user=user,
    role=ProjectRole.MEMBER,
    created_by=request.user,
    expiration_time=None  # Permanent role
)

# Check if user has role
if has_user(project, user, ProjectRole.MEMBER):
    print("User is a project member")

# Update role expiration
update_user(
    scope=project,
    user=user,
    role=ProjectRole.MEMBER,
    expiration_time=new_expiration,
    current_user=request.user
)

# Remove user from role
delete_user(
    scope=project,
    user=user,
    role=ProjectRole.MEMBER,
    current_user=request.user
)

Filtering by Permissions

Using get_connected_customers and get_connected_projects

These functions return all customers/projects where the user has any role:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_core.structure.managers import (
    get_connected_customers,
    get_connected_projects,
    get_connected_customers_by_permission,
    get_connected_projects_by_permission
)

# Get all connected customers
customers = get_connected_customers(user)

# Get customers where user is owner
owner_customers = get_connected_customers(user, RoleEnum.CUSTOMER_OWNER)

# Get projects where user can update
can_update_projects = get_connected_projects_by_permission(
    user,
    PermissionEnum.UPDATE_PROJECT
)

Permission Categories

Offering Permissions

Permission Description
OFFERING.CREATE Create new offerings
OFFERING.UPDATE Update offering details
OFFERING.DELETE Delete offerings
OFFERING.PAUSE/UNPAUSE Control offering availability
OFFERING.MANAGE_USER_GROUP Manage offering user groups

Resource Permissions

Permission Description
RESOURCE.TERMINATE Terminate resources
RESOURCE.SET_USAGE Report resource usage
RESOURCE.SET_LIMITS Update resource limits
RESOURCE.SET_STATE Change resource state

Order Permissions

Permission Description
ORDER.LIST View orders
ORDER.APPROVE Approve orders
ORDER.REJECT Reject orders
ORDER.CANCEL Cancel orders

Project/Customer Permissions

Permission Description
PROJECT.CREATE Create projects
PROJECT.UPDATE Update project details
PROJECT.DELETE Delete projects
CUSTOMER.CREATE Create customers
CUSTOMER.UPDATE Update customer details

Best Practices

1. Always Use PermissionEnum

Define permissions in PermissionEnum to ensure they're properly registered and available to the frontend:

1
2
3
4
5
6
# Good
class PermissionEnum(str, Enum):
    MY_ACTION = 'RESOURCE.MY_ACTION'

# Bad - Won't be visible to frontend
MY_ACTION = 'RESOURCE.MY_ACTION'

2. Use Appropriate Scopes

Choose the right scope for permission checks:

1
2
3
4
5
6
7
8
# For customer-level actions
has_permission(request, permission, customer)

# For project-level actions
has_permission(request, permission, project)

# For offering-specific actions
has_permission(request, permission, offering)

3. Implement Proper Permission Chains

When checking permissions on nested resources, traverse to the appropriate scope:

1
2
3
4
5
# Check permission on resource's customer
has_permission(request, permission, resource.offering.customer)

# Check permission on order's project
has_permission(request, permission, order.project)

4. Use Filter Backends for List Views

For list endpoints, use GenericRoleFilter or implement custom filtering:

1
2
class MyViewSet(viewsets.ModelViewSet):
    filter_backends = [GenericRoleFilter, DjangoFilterBackend]

5. Audit Role Changes

Role changes are automatically logged via signals (role_granted, role_updated, role_revoked) with enhanced context including initiator and reason. Always pass current_user and optional reason for clear audit trails:

1
2
3
4
5
6
7
# Basic usage - uses default reasons
add_user(scope, user, role, created_by=request.user)
delete_user(scope, user, role, current_user=request.user)

# Enhanced usage with specific reasons
delete_user(scope, user, role, current_user=request.user, reason="User left organization")
user_role.revoke(current_user=request.user, reason="Security policy violation")

Enhanced Logging Context

All role change logs now include:

  • initiated_by: Shows either "System" (for automatic operations) or "User Name (username)" (for manual operations)
  • reason: Specific reason for the change, with automatic defaults:
  • Manual API operations: "Manual role assignment/removal/update via API"
  • Automatic expiration: "Automatic expiration" or "Automatic expiration cleanup task"
  • Project deletion: "Project deletion cascade"
  • Scope changes: "Project moved to different customer", "Offering moved to different provider"

Common Automatic Reasons

The system automatically assigns these reasons when not explicitly provided:

Scenario Default Reason
API user operations with current_user "Manual [operation] via API"
Expiration task "Automatic expiration cleanup task"
Project deletion "Project deletion cascade"
Role expiration detection "Automatic expiration"
System operations without current_user "System-initiated [operation]"

6. Performance and Accuracy Guidelines

Exact User Counting

When counting users across roles, always use exact calculations to avoid double-counting users with multiple roles:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Good: Exact counting with distinct()
user_count = (
    UserRole.objects.filter(is_active=True, scope=customer)
    .values("user_id")
    .distinct()
    .count()
)

# Bad: Approximation that double-counts users
customer_users = UserRole.objects.filter(content_type=customer_ct, object_id=customer.id).count()
project_users = UserRole.objects.filter(content_type=project_ct, object_id__in=project_ids).count()
total = customer_users + project_users  # This double-counts users with both roles

Query Optimization

Use Django ORM efficiently for permission-related queries:

1
2
3
4
5
6
7
8
# Use select_related for foreign key relationships
roles = UserRole.objects.filter(user=user).select_related('content_type', 'role')

# Use prefetch_related for reverse relationships
customers = Customer.objects.prefetch_related('userrole_set__user')

# Filter at database level rather than in Python
active_roles = UserRole.objects.filter(is_active=True, expiration_time__gte=timezone.now())

Error Handling Best Practices

Handle edge cases gracefully in permission checking:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def has_permission(request, permission, scope):
    # Handle None scope gracefully
    if scope is None:
        return False

    # ... rest of permission logic

def permission_factory(permission, sources=None):
    def permission_function(request, view, scope=None):
        if not scope:
            return

        if sources:
            attribute_errors = 0
            for path in sources:
                try:
                    source = scope
                    if path != "*":
                        for part in path.split("."):
                            source = getattr(source, part)
                    if has_permission(request, permission, source):
                        return
                except AttributeError:
                    attribute_errors += 1
                    continue

            # If all paths failed due to AttributeError, it's a configuration error
            if attribute_errors == len(sources):
                raise AttributeError(f"None of the attribute paths {sources} exist on the scope object")

        # If we reach here, permission was denied
        raise exceptions.PermissionDenied()

7. Time-based Role Best Practices

Default Parameter Behavior

The has_user function has specific behavior for the expiration_time parameter:

1
2
3
4
5
6
7
8
9
# Check for any active role (default behavior)
has_user(scope, user, role)  # expiration_time=False by default

# Check for only permanent roles
has_user(scope, user, role, expiration_time=None)

# Check if role will be active at specific time
future_time = timezone.now() + timedelta(days=30)
has_user(scope, user, role, expiration_time=future_time)

API Design Consistency

When designing permission-related APIs:

  • Default parameters should match the most common use case
  • Error types should be consistent:
  • AttributeError for configuration/code errors (invalid attribute paths)
  • PermissionDenied for access control failures
  • ValidationError for user input errors

Testing and Debugging Permissions

Testing Permission Logic

When writing tests for permission functionality:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class PermissionTest(TestCase):
    def setUp(self):
        self.fixture = fixtures.CustomerFixture()
        self.customer = self.fixture.customer
        self.user = self.fixture.owner

    def test_user_counting_accuracy(self):
        """Test that user counting handles overlapping roles correctly."""
        # Create user with multiple roles
        self.customer.add_user(self.user, CustomerRole.OWNER)
        self.fixture.project.add_user(self.user, ProjectRole.ADMIN)

        # Count should be 1, not 2 (no double counting)
        user_count = count_users(self.customer)
        self.assertEqual(user_count, 1)

    def test_permission_factory_error_handling(self):
        """Test permission factory handles invalid paths correctly."""
        permission_func = permission_factory(
            PermissionEnum.UPDATE_OFFERING,
            ["nonexistent.attribute"]
        )

        # Should raise AttributeError for configuration errors
        with self.assertRaises(AttributeError):
            permission_func(mock_request, None, self.customer)

Performance Testing

Monitor query counts for permission-related operations:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@override_settings(DEBUG=True)
def test_permission_query_optimization(self):
    """Test that permission checks use reasonable number of queries."""
    from django.db import connection

    # Create test data
    users = [UserFactory() for _ in range(5)]
    for user in users:
        self.customer.add_user(user, CustomerRole.SUPPORT)

    connection.queries.clear()

    # Test permission check
    has_permission(users[0], PermissionEnum.LIST_ORDERS, self.customer)
    permission_queries = len(connection.queries)

    # Should use reasonable number of queries (not O(n) per user)
    self.assertLessEqual(permission_queries, 3)

Debugging Permission Issues

When debugging permission problems:

  1. Check role assignments:
1
2
3
# Verify user has expected roles
roles = UserRole.objects.filter(user=user, is_active=True)
print(f"User roles: {[(r.content_object, r.role.name) for r in roles]}")
  1. Verify permission assignments:
1
2
3
4
# Check if role has required permissions
role = CustomerRole.OWNER
permissions = role.permissions.values_list('permission', flat=True)
print(f"Role permissions: {list(permissions)}")
  1. Test permission paths:
1
2
3
4
5
6
7
8
# Test attribute path resolution
try:
    source = resource
    for part in "offering.customer".split("."):
        source = getattr(source, part)
    print(f"Path resolved to: {source}")
except AttributeError as e:
    print(f"Path resolution failed: {e}")
  1. Enable verbose logging:
1
2
import logging
logging.getLogger('waldur_core.permissions').setLevel(logging.DEBUG)

Common Issues and Solutions

Issue: User count approximations

Problem: Double-counting users with multiple roles

Solution: Always use distinct() on user_id when counting across multiple role assignments

Issue: Permission factory AttributeError

Problem: Invalid attribute paths in permission_factory sources

Solution: Verify object relationships and use try/catch for graceful error handling

Issue: Performance degradation in role filtering

Problem: N+1 queries when checking permissions for many objects

Solution: Use select_related() and prefetch_related() to optimize database queries

Issue: Time-based role confusion

Problem: Unclear behavior of has_user with different expiration_time parameters

Solution: Understand the three modes:

  • expiration_time=False (default): Any active role
  • expiration_time=None: Only permanent roles
  • expiration_time=datetime: Roles active at specific time

Waldur Proposal Module

The Waldur proposal module provides a comprehensive research proposal management system that enables institutions to manage competitive resource allocation through structured calls for proposals, peer review processes, and automated resource provisioning.

Architecture Overview

The proposal system follows a Call → Round → Proposal → Review → Allocation architecture that handles the complete lifecycle from call publication to resource delivery:

graph TB
    subgraph "Call Management"
        CMO[CallManagingOrganisation] --> C[Call]
        C --> RO[RequestedOffering]
        C --> CRT[CallResourceTemplate]
        CD[CallDocument] --> C
    end

    subgraph "Submission Process"
        C --> R[Round]
        R --> P[Proposal]
        P --> RR[RequestedResource]
        P --> PD[ProposalDocumentation]
        P --> MP[Waldur Project]
    end

    subgraph "Review System"
        P --> REV[Review]
        REV --> RC[ReviewComment]
        U[User/Reviewer] --> REV
    end

    subgraph "Resource Allocation"
        P --> RA[ResourceAllocator]
        RR --> MR[Marketplace Resource]
        RA --> MR
        PPRM[ProposalProjectRoleMapping] --> MP
    end

Core Models

  • CallManagingOrganisation: Organizations that create and manage calls for proposals
  • Call: Main entity representing calls with configuration for review settings and duration
  • Round: Time-bounded submission periods with configurable review and allocation strategies
  • Proposal: Individual proposals with project details and resource requests
  • RequestedResource: Specific resource requests within proposals linked to marketplace
  • Review: Peer review system with scoring, comments, and field-specific feedback

Call Lifecycle and State Management

Call States

Calls progress through a simple but effective state machine:

stateDiagram-v2
    [*] --> DRAFT : Call created

    DRAFT --> ACTIVE : Call published
    DRAFT --> ARCHIVED : Call canceled

    ACTIVE --> ARCHIVED : Call completed

    ARCHIVED --> [*]

Call State Descriptions

State Description Operations Allowed
DRAFT Call being prepared by organization Edit call details, add rounds, configure offerings
ACTIVE Call open for submissions Submit proposals, manage reviews, allocate resources
ARCHIVED Call completed or canceled View historical data, generate reports

Proposal States

Proposals follow a comprehensive lifecycle with review integration:

stateDiagram-v2
    [*] --> DRAFT : Proposal created

    DRAFT --> SUBMITTED : Submitter ready
    DRAFT --> CANCELED : Submitter cancels

    SUBMITTED --> IN_REVIEW : Review process starts
    SUBMITTED --> CANCELED : Admin cancels

    IN_REVIEW --> ACCEPTED : Positive review outcome
    IN_REVIEW --> REJECTED : Negative review outcome
    IN_REVIEW --> CANCELED : Process canceled

    ACCEPTED --> [*] : Resources allocated
    REJECTED --> [*] : Process complete
    CANCELED --> [*] : Process terminated

Proposal State Descriptions

State Description Triggers Actions Available
DRAFT Proposal being prepared User creation Edit, add resources, upload docs
SUBMITTED Proposal submitted for review User submission View, withdraw
IN_REVIEW Under review by experts System/admin trigger Review, comment, score
ACCEPTED Approved for resource allocation Review completion Allocate resources, create project
REJECTED Declined after review Review completion View feedback, appeal
CANCELED Withdrawn or administratively canceled User/admin action Archive

Review States

Reviews maintain independent state for tracking progress:

stateDiagram-v2
    [*] --> CREATED : Review assigned

    CREATED --> IN_REVIEW : Reviewer starts
    CREATED --> REJECTED : Reviewer declines

    IN_REVIEW --> SUBMITTED : Review completed
    IN_REVIEW --> REJECTED : Reviewer withdraws

    SUBMITTED --> [*] : Review processed
    REJECTED --> [*] : Assignment ended

Round Management and Strategies

Review Strategies

Rounds can be configured with different review timing approaches:

Strategy Description Use Case Workflow
AFTER_ROUND Reviews start after submission deadline Large competitive calls All proposals collected → batch review assignment
AFTER_PROPOSAL Reviews start immediately upon submission Rolling submissions Individual proposal → immediate review assignment

Allocation Strategies

Resource allocation can be automated or manual:

Strategy Description Decision Maker Allocation Logic
BY_CALL_MANAGER Manual allocation by call administrators Human reviewers Call manager reviews scores and allocates
AUTOMATIC Automated based on review scores System algorithm Automatic allocation above score threshold

Round Configuration

graph LR
    subgraph "Round Configuration"
        ST[Start Time] --> CT[Cutoff Time]
        CT --> RD[Review Duration]
        RD --> MR[Min Reviewers]
        MR --> MS[Min Score]
        MS --> AD[Allocation Date]
    end

    subgraph "Strategies"
        RS[Review Strategy:<br/>AFTER_ROUND/<br/>AFTER_PROPOSAL]
        AS[Allocation Strategy:<br/>BY_CALL_MANAGER/<br/>AUTOMATIC]
        AT[Allocation Time:<br/>ON_DECISION/<br/>FIXED_DATE]
    end

Resource Template System

Template Architecture

Call resource templates standardize resource requests across proposals:

graph TB
    subgraph "Template Definition"
        C[Call] --> CRT[CallResourceTemplate]
        RO[RequestedOffering] --> CRT
        CRT --> A[Attributes JSON]
        CRT --> L[Limits JSON]
        CRT --> REQ[Is Required]
    end

    subgraph "Proposal Usage"
        P[Proposal] --> RR[RequestedResource]
        CRT --> RR
        RR --> PA[Proposal Attributes]
        RR --> PL[Proposal Limits]
    end

    subgraph "Validation"
        CRT --> V[Template Validation]
        RR --> V
        V --> MR[Marketplace Resource]
    end

Template Configuration Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Template for HPC compute allocation
{
    "name": "Standard HPC Allocation",
    "attributes": {
        "cluster": "hpc-production",
        "partition": "general",
        "max_walltime": "72:00:00"
    },
    "limits": {
        "cpu_hours": {"max": 100000, "default": 10000},
        "gpu_hours": {"max": 5000, "default": 0},
        "storage_gb": {"max": 1000, "default": 100}
    },
    "is_required": True
}

Review System Architecture

Review Assignment

The system supports flexible reviewer assignment strategies:

sequenceDiagram
    participant R as Round
    participant P as Proposal
    participant RM as ReviewManager
    participant Rev as Reviewer
    participant N as NotificationSystem

    Note over R: Review Strategy Check

    alt After Round Strategy
        R->>R: Cutoff time reached
        R->>RM: Assign reviewers to all proposals
    else After Proposal Strategy
        P->>P: State changed to SUBMITTED
        P->>RM: Assign reviewers immediately
    end

    RM->>Rev: Create review assignments
    RM->>N: Notify assigned reviewers
    Rev->>Rev: Complete reviews
    RM->>RM: Aggregate review results

Review Scoring System

Reviews include comprehensive scoring and feedback:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
class Review:
    # Overall assessment
    summary_score: int  # 1-10 scale
    summary_public_comment: str  # Visible to submitters
    summary_private_comment: str  # Internal use only

    # Field-specific feedback
    comment_project_title: str
    comment_project_summary: str
    comment_project_description: str
    comment_project_duration: str
    comment_resource_requests: str
    comment_team: str

    # Confidentiality assessments
    comment_project_is_confidential: str
    comment_project_has_civilian_purpose: str
    comment_project_supporting_documentation: str

Review Visibility Configuration

Calls can configure review transparency:

Setting Description Impact
reviewer_identity_visible_to_submitters Whether submitters see reviewer names False: Shows "Reviewer 1", "Reviewer 2"
reviews_visible_to_submitters Whether submitters see review details False: Only final decision visible

Integration with Waldur Marketplace

Resource Provisioning Flow

Accepted proposals automatically trigger marketplace resource creation:

sequenceDiagram
    participant P as Proposal
    participant RA as ResourceAllocator
    participant MP as Marketplace
    participant R as Resource
    participant Proj as Project

    P->>P: State changed to ACCEPTED
    P->>RA: Create allocator
    RA->>MP: Create marketplace order
    MP->>R: Provision resources
    R->>Proj: Link to proposal project

    Note over Proj: Automatic role mapping
    RA->>Proj: Apply ProposalProjectRoleMapping

Role Mapping System

The ProposalProjectRoleMapping enables automatic role assignment:

1
2
3
4
5
6
# Example: Map proposal PI to project manager
ProposalProjectRoleMapping.objects.create(
    call=call,
    proposal_role=Role.objects.get(name="Principal Investigator"),
    project_role=Role.objects.get(name="Project Manager")
)

When proposals are accepted:

  1. System identifies users with proposal roles
  2. Automatically assigns corresponding project roles
  3. Users gain appropriate project permissions
  4. Resources become accessible immediately

Realistic Usage Examples

1. Academic HPC Resource Allocation

Use Case: University research computing center allocating CPU hours

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Call configuration
call = Call.objects.create(
    name="2024 Spring HPC Allocation",
    manager=university_hpc_center,
    state=CallStates.ACTIVE,
    reviewer_identity_visible_to_submitters=False,
    reviews_visible_to_submitters=True,
    fixed_duration_in_days=365  # 1-year allocations
)

# Round with automatic allocation
round = Round.objects.create(
    call=call,
    start_time=datetime(2024, 1, 1),
    cutoff_time=datetime(2024, 2, 15),
    review_strategy=Round.ReviewStrategies.AFTER_ROUND,
    deciding_entity=Round.AllocationStrategies.AUTOMATIC,
    minimal_average_scoring=7.0,  # Require 7/10 average
    minimum_number_of_reviewers=3
)

# Resource template
template = CallResourceTemplate.objects.create(
    call=call,
    name="Standard Compute Allocation",
    requested_offering=hpc_offering,
    attributes={
        "cluster": "frontera",
        "partition": "normal",
        "max_walltime": "48:00:00"
    },
    limits={
        "cpu_hours": {"max": 1000000, "default": 50000},
        "storage_gb": {"max": 10000, "default": 1000}
    },
    is_required=True
)

Workflow:

  1. Researchers submit proposals with resource requests
  2. Expert reviewers evaluate scientific merit
  3. Proposals scoring ≥7.0 automatically receive allocations
  4. HPC accounts created with specified limits
  5. Usage tracked through marketplace billing

2. Cloud Infrastructure Grant Program

Use Case: Government agency providing cloud resources for research

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Multi-round competitive program
call = Call.objects.create(
    name="National Cloud Research Initiative",
    manager=government_agency,
    reviewer_identity_visible_to_submitters=True,  # Transparent process
    reviews_visible_to_submitters=True
)

# Quarterly rounds with manual allocation
round_q1 = Round.objects.create(
    call=call,
    start_time=datetime(2024, 1, 1),
    cutoff_time=datetime(2024, 3, 15),
    review_strategy=Round.ReviewStrategies.AFTER_ROUND,
    deciding_entity=Round.AllocationStrategies.BY_CALL_MANAGER,
    allocation_time=Round.AllocationTimes.FIXED_DATE,
    allocation_date=datetime(2024, 4, 1)
)

# Multiple resource options
compute_template = CallResourceTemplate.objects.create(
    call=call,
    name="Compute Instance Package",
    requested_offering=aws_compute_offering,
    limits={
        "vcpu": {"max": 100, "default": 8},
        "memory_gb": {"max": 500, "default": 32},
        "storage_gb": {"max": 1000, "default": 100}
    }
)

storage_template = CallResourceTemplate.objects.create(
    call=call,
    name="Data Storage Package",
    requested_offering=aws_storage_offering,
    limits={
        "storage_gb": {"max": 10000, "default": 1000},
        "backup_retention_days": {"max": 90, "default": 30}
    }
)

Workflow:

  1. Research teams submit project proposals
  2. Panel review with domain experts
  3. Program managers manually select winning proposals
  4. Resources allocated on fixed quarterly dates
  5. Multi-year projects supported with renewal process

3. Startup Incubator Resource Program

Use Case: Accelerator providing development resources to startups

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Rolling admission program
call = Call.objects.create(
    name="TechHub Startup Resources 2024",
    manager=tech_incubator,
    reviewer_identity_visible_to_submitters=False,
    reviews_visible_to_submitters=False  # Confidential evaluation
)

# Continuous rolling rounds
rolling_round = Round.objects.create(
    call=call,
    start_time=datetime(2024, 1, 1),
    cutoff_time=datetime(2024, 12, 31),
    review_strategy=Round.ReviewStrategies.AFTER_PROPOSAL,  # Immediate review
    deciding_entity=Round.AllocationStrategies.BY_CALL_MANAGER,
    review_duration_in_days=14  # Fast turnaround
)

# Startup development package
dev_template = CallResourceTemplate.objects.create(
    call=call,
    name="Startup Development Kit",
    requested_offering=development_platform_offering,
    attributes={
        "environment": "production_ready",
        "monitoring": "basic",
        "backup": "daily"
    },
    limits={
        "developer_seats": {"max": 10, "default": 3},
        "deployment_environments": {"max": 3, "default": 2},
        "monthly_compute_hours": {"max": 1000, "default": 200}
    },
    is_required=True
)

Workflow:

  1. Startups apply continuously throughout year
  2. Industry mentors review applications within 14 days
  3. Incubator staff make acceptance decisions
  4. Resources provisioned immediately upon acceptance
  5. 6-month duration with renewal option

Compliance Checklist Integration

Optional Compliance Requirements

Calls can optionally include compliance checklists that proposals must complete before submission. This feature integrates with the marketplace checklist system to ensure regulatory or institutional compliance requirements are met.

graph TB
    subgraph "Compliance Flow"
        C[Call] --> CC[Compliance Checklist]
        CC --> P[Proposal]
        P --> PCC[ProposalChecklistCompletion]
        PCC --> PCA[ProposalChecklistAnswer]
        PCA --> VS[Validation & Submission]
    end

    subgraph "Question Types"
        CC --> BQ[Boolean Questions]
        CC --> TQ[Text Questions]
        CC --> SQ[Select Questions]
        CC --> DQ[Date Questions]
    end

    subgraph "Review Triggers"
        PCA --> RT[Review Triggers]
        RT --> CMR[Call Manager Review]
        CMR --> A[Approval/Comments]
    end

Compliance Checklist Configuration

Call managers can assign compliance checklists when creating or editing calls:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Call with compliance requirements
call = Call.objects.create(
    name="Ethical Research Initiative 2024",
    manager=research_office,
    compliance_checklist=ethics_checklist,  # Optional compliance checklist
    state=CallStates.ACTIVE
)

# Compliance checklist example
ethics_checklist = Checklist.objects.create(
    name="Research Ethics Compliance",
    checklist_type=ChecklistTypes.PROPOSAL_COMPLIANCE,
    description="Mandatory ethics review for all research proposals"
)

# Compliance questions
Question.objects.create(
    checklist=ethics_checklist,
    description="Does your research involve human subjects?",
    question_type=QuestionTypes.BOOLEAN,
    required=True,
    review_answer_value=True,  # 'Yes' triggers call manager review
    operator="equals",
    order=1
)

Question.objects.create(
    checklist=ethics_checklist,
    description="Describe your data protection measures",
    question_type=QuestionTypes.TEXT_AREA,
    required=True,
    order=2
)

Automatic Checklist Assignment

When proposals are created for calls with compliance checklists, completion tracking is automatically initialized:

sequenceDiagram
    participant U as User
    participant P as Proposal
    participant S as Signal Handler
    participant PCC as ProposalChecklistCompletion

    U->>P: Create proposal
    P->>P: Save to database
    P->>S: Trigger post_save signal

    alt Call has compliance checklist
        S->>PCC: Create completion tracking
        PCC->>PCC: Initialize as incomplete
    else No compliance checklist
        S->>S: No action needed
    end

Proposal Compliance Workflow

1. Compliance Checklist Access

Proposal managers can access compliance checklists through dedicated endpoints:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# API endpoint: GET /api/proposal-proposals/{uuid}/compliance_checklist/
{
    "checklist": {
        "uuid": "...",
        "name": "Research Ethics Compliance",
        "checklist_type": "proposal_compliance"
    },
    "completion": {
        "is_completed": false,
        "completion_percentage": 0.0,
        "requires_review": false,
        "unanswered_required_count": 3
    },
    "questions": [
        {
            "uuid": "...",
            "description": "Does your research involve human subjects?",
            "question_type": "boolean",
            "required": true,
            "existing_answer": null
        }
    ]
}

2. Answer Submission

Proposal managers submit compliance answers:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# API endpoint: POST /api/proposal-proposals/{uuid}/submit_compliance_answers/
[
    {
        "question_uuid": "...",
        "answer_data": true
    },
    {
        "question_uuid": "...",
        "answer_data": "We follow GDPR guidelines with encrypted storage..."
    }
]

3. Automatic Review Triggering

Certain answers can trigger call manager review requirements:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Question configuration with review trigger
question = Question.objects.create(
    description="Does your research involve vulnerable populations?",
    question_type=QuestionTypes.BOOLEAN,
    review_answer_value=True,  # 'Yes' triggers review
    operator="equals"
)

# When answered 'True', completion is flagged for review
completion.requires_review = True
completion.save()

4. Submission Validation

Proposals cannot be submitted until compliance requirements are met:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
class Proposal:
    def can_submit(self):
        """Check if proposal can be submitted."""
        # Check compliance checklist completion
        if self.round.call.compliance_checklist:
            try:
                completion = self.checklist_completion
                if not completion.is_completed:
                    return False, "Compliance checklist must be completed before submission"
            except ProposalChecklistCompletion.DoesNotExist:
                return False, "Compliance checklist completion missing"

        return True, None

Call Manager Oversight

Call managers have comprehensive oversight capabilities for compliance management:

1. Compliance Overview

View compliance status across all proposals in a call:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# API endpoint: GET /api/proposal-protected-calls/{uuid}/compliance_overview/
{
    "checklist": {
        "name": "Research Ethics Compliance",
        "total_questions": 5,
        "required_questions": 3
    },
    "proposals": [
        {
            "uuid": "...",
            "name": "AI Ethics Study",
            "state": "draft",
            "compliance": {
                "is_completed": true,
                "requires_review": true,
                "completion_percentage": 100.0,
                "reviewed_by": null,
                "review_triggers": [
                    {
                        "question": "Does your research involve human subjects?",
                        "answer": true,
                        "trigger_value": true
                    }
                ]
            }
        }
    ]
}

2. Detailed Answer Review

Access detailed compliance answers for specific proposals:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
# API endpoint: GET /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/
{
    "proposal": {
        "uuid": "...",
        "name": "AI Ethics Study",
        "created_by": "Dr. Jane Smith"
    },
    "completion": {
        "is_completed": true,
        "requires_review": true,
        "completion_percentage": 100.0
    },
    "answers": [
        {
            "question_description": "Does your research involve human subjects?",
            "question_type": "boolean",
            "answer_data": true,
            "requires_review": true,
            "user_name": "Dr. Jane Smith"
        }
    ]
}

3. Compliance Review and Approval

Call managers can review and approve compliance requirements:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# API endpoint: POST /api/proposal-protected-calls/{uuid}/review_proposal_compliance/
{
    "proposal_uuid": "...",
    "review_notes": "Ethics approval obtained from IRB. Data protection measures adequate."
}

# Response includes review confirmation
{
    "detail": "Compliance review completed successfully",
    "reviewed_by": "Prof. Ethics Chair",
    "reviewed_at": "2024-08-01T10:30:00Z"
}

Integration with Proposal Serializers

Proposal serializers automatically include compliance status information:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class ProposalSerializer:
    def get_compliance_status(self, obj):
        """Get compliance checklist status."""
        if not obj.round.call.compliance_checklist:
            return None

        if not hasattr(obj, 'checklist_completion'):
            return {
                "error": "Compliance checklist not initialized",
                "has_checklist": True,
                "is_completed": False
            }

        completion = obj.checklist_completion
        return {
            "has_checklist": True,
            "is_completed": completion.is_completed,
            "requires_review": completion.requires_review,
            "completion_percentage": completion.get_completion_percentage(),
            "reviewed_by": completion.reviewed_by.full_name if completion.reviewed_by else None,
            "checklist_name": completion.checklist.name,
            "unanswered_required_count": completion.get_unanswered_required_questions().count()
        }

    def get_can_submit(self, obj):
        """Get whether proposal can be submitted."""
        can_submit, error = obj.can_submit()
        return {"can_submit": can_submit, "error": error}

Real-World Use Cases

1. University Ethics Compliance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Research ethics checklist for academic proposals
ethics_call = Call.objects.create(
    name="Faculty Research Grant Program",
    manager=university_research_office,
    compliance_checklist=research_ethics_checklist
)

# Sample ethics questions
questions = [
    {
        "description": "Does your research involve human subjects?",
        "type": "boolean",
        "triggers_review": True  # Requires IRB oversight
    },
    {
        "description": "Have you obtained IRB approval?",
        "type": "boolean",
        "required": True
    },
    {
        "description": "Upload IRB approval documentation",
        "type": "file_upload",
        "required_if": "previous_answer_yes"
    }
]

2. Industry Safety Compliance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Industrial research safety checklist
safety_call = Call.objects.create(
    name="Industrial Innovation Grants",
    manager=industrial_research_center,
    compliance_checklist=safety_checklist
)

# Safety compliance questions
safety_questions = [
    {
        "description": "Does your research involve hazardous materials?",
        "type": "boolean",
        "triggers_review": True
    },
    {
        "description": "Select applicable safety categories",
        "type": "multi_select",
        "options": ["Chemical", "Biological", "Radiological", "Physical"]
    },
    {
        "description": "Describe safety protocols and risk mitigation",
        "type": "text_area",
        "required": True
    }
]

3. Government Security Clearance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Security clearance for government research
security_call = Call.objects.create(
    name="Defense Research Initiative",
    manager=defense_agency,
    compliance_checklist=security_clearance_checklist
)

# Security questions with automatic review triggers
security_questions = [
    {
        "description": "Does your research involve classified information?",
        "type": "boolean",
        "triggers_review": True  # Automatic security review
    },
    {
        "description": "List team members requiring security clearance",
        "type": "text_area",
        "required_if": "classified_research"
    },
    {
        "description": "Facility security clearance level",
        "type": "single_select",
        "options": ["Unclassified", "Confidential", "Secret", "Top Secret"]
    }
]

Benefits of Compliance Integration

  1. Automated Compliance Tracking: Ensures all proposals meet regulatory requirements before submission
  2. Flexible Question Types: Supports various question formats (boolean, text, select, date) for comprehensive compliance assessment
  3. Review Triggering: Automatically flags proposals requiring additional oversight based on specific answers
  4. Call Manager Oversight: Provides administrators with comprehensive compliance monitoring and approval capabilities
  5. Audit Trail: Maintains complete records of compliance answers and review decisions
  6. Integration with Submission: Prevents non-compliant proposals from being submitted to review process

The compliance checklist system seamlessly integrates with the existing proposal workflow while providing the flexibility needed for various regulatory and institutional requirements.

Advanced Features

Project Integration

Accepted proposals create Waldur projects with automatic configuration:

graph LR
    subgraph "Proposal Acceptance"
        P[Proposal ACCEPTED] --> PC[Project Creation]
        PC --> RM[Role Mapping]
        RM --> RA[Resource Allocation]
    end

    subgraph "Project Setup"
        PPRM[ProposalProjectRoleMapping] --> AR[Assign Roles]
        AR --> UP[User Permissions]
        UP --> RS[Resource Access]
    end

Notification System

Comprehensive notification system keeps stakeholders informed:

Event Recipients Content
Proposal Submitted Call managers, reviewers New proposal requiring review
Review Assigned Individual reviewers Review assignment with deadline
Review Completed Call managers Review submitted notification
Proposal Accepted Proposal team, call managers Acceptance with resource details
Proposal Rejected Proposal team Rejection with feedback
Round Closing All stakeholders Deadline reminder

Audit Trail

Complete audit logging for compliance and transparency:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# All state changes logged
proposal.tracker.has_changed('state')  # Tracks state transitions
review.tracker.has_changed('summary_score')  # Tracks review updates

# Event logging integration
event_logger.proposal.info(
    'Proposal {proposal_name} has been accepted.',
    event_type=EventType.PROPOSAL_ACCEPTED,
    event_context={'proposal': proposal}
)

Error Handling and Data Integrity

Validation Framework

Comprehensive validation ensures data consistency:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
class ProposalProjectRoleMapping:
    def clean(self):
        # Ensure project role is actually for projects
        if (self.project_role and
            self.project_role.content_type.model_class().__name__ != "Project"):
            raise ValidationError("Role should belong to the project type.")

        # Ensure proposal role is for proposals
        if self.proposal_role.content_type.model_class().__name__ != "Proposal":
            raise ValidationError("Role should belong to the proposal type.")

State Transition Guards

Prevent invalid state changes:

1
2
3
4
5
6
7
8
9
def submit_proposal(proposal):
    if proposal.state != ProposalStates.DRAFT:
        raise IncorrectStateException("Can only submit draft proposals")

    if not proposal.requestedresource_set.exists():
        raise ValidationError("Proposal must include resource requests")

    proposal.state = ProposalStates.SUBMITTED
    proposal.save()

Resource Cleanup

Automatic cleanup for canceled or rejected proposals:

1
2
3
4
5
6
def cleanup_proposal_resources(proposal):
    if proposal.state in [ProposalStates.CANCELED, ProposalStates.REJECTED]:
        # Clean up any provisional resources
        proposal.requestedresource_set.filter(
            resource__state=ResourceStates.CREATING
        ).update(resource__state=ResourceStates.TERMINATED)

Performance Considerations

Query Optimization

  • Eager loading for nested relationships
  • Database indexes on frequently queried fields
  • Efficient permission filtering

Scalability Patterns

  • Asynchronous review assignment for large calls
  • Batch processing for resource allocation
  • Cached statistics for dashboard views

Monitoring Integration

  • Review progress tracking
  • Resource utilization monitoring

Quotas Application

Overview

The Quotas application is a Django app that provides generic implementation of quotas tracking functionality for Waldur:

  1. Store and query resource limits and usages for project, customer or any other model
  2. Aggregate quota usage in object hierarchies
  3. Provide concurrent-safe quota updates using delta-based storage
  4. Support multiple quota field types for different use cases

Architecture

Core Models

QuotaLimit

  • Stores quota limit values for different scopes
  • Uses generic foreign key to relate to any model instance
  • Unique constraint on (name, content_type, object_id)
  • Default value of -1 indicates unlimited quota

QuotaUsage

  • Stores quota usage deltas instead of absolute values
  • Enables concurrent updates without deadlocks
  • Aggregated using SUM queries to get current usage
  • Uses generic foreign key pattern for scope association

QuotaModelMixin

  • Base mixin for models that need quota functionality
  • Provides core quota management methods
  • Defines abstract Quotas inner class for field definitions
  • Includes property accessors for quotas, quota_usages, quota_limits

ExtendableQuotaModelMixin

  • Extends QuotaModelMixin for runtime quota field addition
  • Disables field caching to support dynamic fields
  • Used when quota fields need to be added programmatically

Quota Field Types

QuotaField

  • Base quota field class
  • Configurable default limits and backend flags
  • Optional creation conditions for conditional quota assignment
  • Supports callable default values: QuotaField(default_limit=lambda scope: scope.attr)

CounterQuotaField

  • Automatically tracks count of target model instances
  • Increases/decreases usage on target model creation/deletion
  • Configurable delta calculation via get_delta function
  • Example: nc_resource_count tracks total resources in a project

TotalQuotaField

  • Aggregates sum of specific field values from target models
  • Useful for tracking total storage size, RAM allocation, etc.
  • Extends CounterQuotaField with field-specific aggregation
  • Example: nc_volume_size sums all volume sizes in a project

UsageAggregatorQuotaField

  • Aggregates quota usage from child objects with same quota name
  • Enables hierarchical quota tracking (customer ← project ← resource)
  • Configurable child quota name mapping
  • Example: Customer's nc_resource_count aggregates from all projects

Signal Handling and Automation

Quota Handlers

  • count_quota_handler_factory: Creates handlers for CounterQuotaField automation
  • handle_aggregated_quotas: Manages usage aggregation across hierarchies
  • get_ancestors: Safely traverses object relationships with depth limits
  • delete_quotas_when_model_is_deleted: Cleanup on model deletion

Signal Registration

  • Automatically registers signals for CounterQuotaField instances
  • Connects aggregation handlers to QuotaUsage model signals
  • Handles project customer changes for quota recalculation

Concurrency Safety

Delta-Based Storage

The quota system uses INSERT operations instead of UPDATE to avoid deadlocks:

  • Usage deltas are stored in QuotaUsage records
  • Current usage calculated via SUM aggregation
  • Multiple concurrent requests can safely add usage deltas
  • Prevents shared write deadlocks in high-concurrency scenarios

Transaction Safety

  • set_quota_usage uses @transaction.atomic decorator
  • Quota validation can be enabled per operation
  • Safe quota changes through apply_quota_usage method

Define Quota Fields

Models with quotas should inherit QuotaModelMixin and define a Quotas inner class:

1
2
3
4
5
6
7
from waldur_core.quotas import models as quotas_models, fields as quotas_fields

class Tenant(quotas_models.QuotaModelMixin, models.Model):
    class Quotas(quotas_models.QuotaModelMixin.Quotas):
        vcpu = quotas_fields.QuotaField(default_limit=20, is_backend=True)
        ram = quotas_fields.QuotaField(default_limit=51200, is_backend=True)
        storage = quotas_fields.QuotaField(default_limit=1024000, is_backend=True)

Real-World Examples

Customer Quotas

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
class Quotas(quotas_models.QuotaModelMixin.Quotas):
    enable_fields_caching = False
    nc_project_count = quotas_fields.CounterQuotaField(
        target_models=lambda: [Project],
        path_to_scope="customer",
    )
    nc_user_count = quotas_fields.QuotaField()
    nc_resource_count = quotas_fields.CounterQuotaField(
        target_models=lambda: BaseResource.get_all_models(),
        path_to_scope="project.customer",
    )

Project Quotas

1
2
3
4
5
6
class Quotas(quotas_models.QuotaModelMixin.Quotas):
    enable_fields_caching = False
    nc_resource_count = quotas_fields.CounterQuotaField(
        target_models=lambda: BaseResource.get_all_models(),
        path_to_scope="project",
    )

Quota Operations

Basic Operations

  • get_quota_limit(quota_name) - Get current limit (returns -1 for unlimited)
  • set_quota_limit(quota_name, limit) - Set new quota limit
  • get_quota_usage(quota_name) - Get current usage (SUM of deltas)
  • set_quota_usage(quota_name, usage) - Set absolute usage value
  • add_quota_usage(quota_name, delta, validate=False) - Add delta to usage

Bulk Operations

  • apply_quota_usage(quota_deltas) - Apply multiple quota deltas atomically
  • validate_quota_change(quota_deltas) - Validate quota changes before applying

Property Access

  • quotas - List of all quotas with name, usage, limit
  • quota_usages - Dictionary of current usage values
  • quota_limits - Dictionary of current limit values

Quota Validation

Use validate_quota_change() to check if quota changes would exceed limits:

1
2
3
4
5
try:
    instance.validate_quota_change({'ram': 1024, 'storage': 2048})
except QuotaValidationError as e:
    # Handle quota exceeded error
    pass

Shared Quota Resources

For resources that affect multiple quota scopes, implement SharedQuotaMixin:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
class MyResource(SharedQuotaMixin, models.Model):
    def get_quota_deltas(self):
        return {'storage': self.size, 'volumes': 1}

    def get_quota_scopes(self):
        return [self.project, self.tenant]

    def save(self, *args, **kwargs):
        super().save(*args, **kwargs)
        self.increase_backend_quotas_usage(validate=True)

Background Tasks

Celery Tasks

  • update_custom_quotas() - Triggers custom quota recalculation signal
  • update_standard_quotas() - Recalculates all standard quota fields

These tasks enable periodic quota synchronization and can be scheduled via cron.

Performance Considerations

Hierarchy Traversal

  • get_ancestors() includes depth limits (max_depth=10) to prevent infinite recursion
  • Handles deletion scenarios gracefully with ObjectDoesNotExist catching
  • Uses sets to eliminate duplicate ancestors in complex hierarchies

Deletion Optimization

  • Skips aggregation during bulk deletion (project deletion scenarios)
  • Uses _deleting flag to avoid timeout issues
  • Automatically cleans up quota records on model deletion

Query Optimization

  • Uses Sum() aggregation for efficient usage calculation
  • Generic foreign keys enable single tables for all quota types
  • Field caching can be disabled for dynamic quota scenarios

Error Handling

Exception Types

  • QuotaError - Base quota system exception
  • QuotaValidationError - Extends DRF ValidationError for quota limit violations

Graceful Degradation

  • Missing relationships during deletion are safely ignored
  • Invalid scopes return empty quota collections
  • Failed quota operations don't break primary workflows

Integration Points

Structure Integration

  • Customer and Project models include standard quota definitions
  • Project movement between customers triggers quota recalculation
  • User count and resource count quotas are tracked automatically

Plugin Integration

  • recalculate_quotas signal allows plugin-specific quota logic
  • Backend quota synchronization through plugin-specific handlers
  • Resource-specific quota fields defined in individual plugins

Usage Workflow

Standard Workflow

  1. Quota Allocation: Increase usage when resource allocation begins
  2. Validation: Check quota limits before proceeding with operations
  3. Backend Sync: Pull actual usage from backends periodically
  4. Cleanup: Decrease usage only when backend deletion succeeds

Error Recovery

  • Frontend quota not modified if backend API calls fail
  • Quota pulling (sync) handles discrepancies
  • Manual recalculation available via management commands

Sort Objects by Quotas

Inherit your FilterSet from QuotaFilterMixin and add quota ordering:

1
2
class Meta:
    order_by = ['name', 'quotas__limit', '-quotas__limit']

Ordering can be done only by one quota at a time.

Tasks and executors

Overview

Waldur performs logical operations using executors that combine several tasks. This document explains the executor pattern, its implementation in Waldur, and provides examples of real-world usage.

Executor Pattern

Executor represents a logical operation on a backend, like VM creation or resize. It executes one or more background tasks and takes care of resource state updates and exception handling. The pattern provides several benefits:

  • Abstraction: Hides complex backend interactions behind a simple interface
  • Consistency: Ensures consistent state management across operations
  • Modularity: Allows reusing common tasks across different operations
  • Task Coordination: Simplifies orchestration of multiple related tasks

Basic Executor Flow

  1. Pre-apply phase: Prepare the resource by handling initial state transition
  2. Task generation: Create Celery task signature or chain of tasks
  3. Success/failure handlers: Define how to handle task completion or errors
  4. Execution: Process tasks either asynchronously or synchronously

Types of Executors

Waldur implements several specialized executors that inherit from the BaseExecutor class:

  • CreateExecutor: For creating resources (sets state to OK on success)
  • UpdateExecutor: For updating resources (schedules updating before actual update)
  • DeleteExecutor: For deleting resources (schedules deleting before actual deletion)
  • ActionExecutor: For executing specific actions on resources (custom operations)

Scheduling Celery task from signal handler

Please use transaction.on_commit wrapper if you need to schedule Celery task from signal handler. Otherwise, Celery task is scheduled too early and executed even if object is not yet saved to the database. See also django docs

Task Types

There are 3 types of task queues: regular (used by default), heavy and background.

Regular tasks

Each regular task corresponds to a particular granular action - like state transition, object deletion or backend method execution. They are supposed to be combined and called in executors. It is not allowed to schedule tasks directly from views or serializer.

Heavy tasks

If task takes too long to complete, you should try to break it down into smaller regular tasks in order to avoid flooding general queue. Only if backend does not allow to do so, you should mark such tasks as heavy so that they use separate queue.

1
2
3
  @shared_task(is_heavy_task=True)
  def heavy(uuid=0):
    print('** Heavy %s' % uuid)

Throttle tasks

Some backends don't allow to execute several operations concurrently within the same scope. For example, one OpenStack settings does not support provisioning of more than 4 instances together. In this case task throttling should be used.

Background tasks

Tasks that are executed by celerybeat should be marked as "background". To mark task as background you need to inherit it from core.BackgroundTask:

1
2
3
4
  from waldur_core.core import tasks as core_tasks
  class MyTask(core_tasks.BackgroundTask):
    def run(self):
      print('** Background task')

Explore BackgroundTask to discover background tasks features.

Task registration

For class based tasks use old Task base class for compatibility:

1
  from celery import Task

For functions use decorator shared_task:

1
2
3
4
5
6
  from celery import shared_task


  @shared_task
  def add(x, y):
      return x + y

Real-world Example: OpenStack Instance Creation

The OpenStack plugin's InstanceCreateExecutor demonstrates a complex real-world implementation of the executor pattern. It orchestrates multiple tasks:

  1. Creates all volumes for the instance
  2. Creates necessary network ports
  3. Creates the instance itself on the OpenStack backend
  4. Attaches volumes to the instance
  5. Updates security groups
  6. Creates and attaches floating IPs
  7. Pulls the final state of the instance and related resources

Each step is carefully orchestrated with appropriate state transitions, error handling, and checks to ensure the operation completes successfully.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class InstanceCreateExecutor(core_executors.CreateExecutor):
    @classmethod
    def get_task_signature(cls, instance, serialized_instance, ssh_key=None, flavor=None, server_group=None):
        serialized_volumes = [
            core_utils.serialize_instance(volume) for volume in instance.volumes.all()
        ]
        _tasks = [
            tasks.ThrottleProvisionStateTask().si(
                serialized_instance, state_transition="begin_creating"
            )
        ]
        _tasks += cls.create_volumes(serialized_volumes)
        _tasks += cls.create_ports(serialized_instance)
        _tasks += cls.create_instance(serialized_instance, flavor, ssh_key, server_group)
        _tasks += cls.pull_volumes(serialized_volumes)
        _tasks += cls.pull_security_groups(serialized_instance)
        _tasks += cls.create_floating_ips(instance, serialized_instance)
        _tasks += cls.pull_server_group(serialized_instance)
        _tasks += cls.pull_instance(serialized_instance)
        return chain(*_tasks)

    # ... additional methods for each step ...

Common Task Types in Executors

Executors typically use the following task types:

  1. BackendMethodTask: Executes a method on the backend resource
1
core_tasks.BackendMethodTask().si(serialized_resource, "create_resource")
  1. StateTransitionTask: Changes the state of a resource
1
core_tasks.StateTransitionTask().si(serialized_resource, state_transition="set_ok")
  1. PollRuntimeStateTask: Polls the backend until a resource reaches a desired state
1
2
3
4
5
6
core_tasks.PollRuntimeStateTask().si(
    serialized_resource,
    backend_pull_method="pull_runtime_state",
    success_state="running",
    erred_state="error"
)
  1. PollBackendCheckTask: Checks if a backend operation has completed
1
core_tasks.PollBackendCheckTask().si(serialized_resource, "is_resource_deleted")

Executor-Task Relationship

Executors construct and manage task chains, providing a higher-level interface for complex operations.

Best Practices

  1. Use appropriate executor type based on operation (create, update, delete, action)
  2. Implement pre_apply for necessary state transitions
  3. Handle both success and failure cases with appropriate signatures
  4. Use transaction.on_commit when scheduling from signal handlers
  5. Break down long-running tasks into smaller chunks
  6. Use throttling when backend has concurrency limitations

Ended: Core concepts

Build, Test, and Lint Commands

Development Setup

  • Install dev dependencies: uv sync --extra dev

Testing Commands

  • Run all tests: DJANGO_SETTINGS_MODULE=waldur_core.server.my_test_settings uv run pytest
  • Run specific module tests: DJANGO_SETTINGS_MODULE=waldur_core.server.my_test_settings uv run pytest src/waldur_core/core/tests/test_serializers.py
  • Run single test: DJANGO_SETTINGS_MODULE=waldur_core.server.my_test_settings uv run pytest src/waldur_core/core/tests/test_serializers.py::RestrictedSerializerTest::test_serializer_returns_fields_required_in_request -v
  • Verbose output: Add -v -s flags for detailed output with print statements

Code Quality Commands

  • Lint code: uv run pre-commit run --all-files
  • Format code: uv run pre-commit run --all-files
  • Check code style: uv run pre-commit run --all-files

Markdown Linting

  • Lint docs directory: mdl --style markdownlint-style.rb docs/
  • Lint project docs: mdl --style markdownlint-style.rb CLAUDE.md docs/
  • Lint specific file: mdl --style markdownlint-style.rb path/to/file.md

Claude Code Subagent Validation

  • Validate subagents: .claude/validate-agents.sh

Common MD007 Issues and Fixes

  • Use exactly 2 spaces for nested list items (configured in markdownlint-style.rb)
  • Be consistent - if parent uses * or -, all children at same level should use same indentation
  • Table section headers need empty cells to match column count: | **Section** | | |
  • Fix incrementally - ensure ALL items at the same nesting level use identical spacing

Debugging Markdown Issues

  • Use sed -n 'Xp' file | hexdump -C to see exact spacing (look for 20 20 = 2 spaces)
  • Run mdl --verbose to see which specific rule is processing
  • Check markdownlint-style.rb for custom rule configurations

Development Philosophy

Core Beliefs

  • Incremental progress over big bangs - Small changes that compile and pass tests
  • Learning from existing code - Study and plan before implementing
  • Pragmatic over dogmatic - Adapt to project reality
  • Clear intent over clever code - Be boring and obvious

Simplicity Means

  • Single responsibility per function/class
  • Avoid premature abstractions
  • No clever tricks - choose the boring solution
  • If you need to explain it, it's too complex

Process

1. Planning & Staging

Break complex work into 3-5 stages. Document in IMPLEMENTATION_PLAN.md:

1
2
3
4
5
## Stage N: [Name]
**Goal**: [Specific deliverable]
**Success Criteria**: [Testable outcomes]
**Tests**: [Specific test cases]
**Status**: [Not Started|In Progress|Complete]
  • Update status as you progress
  • Remove file when all stages are done

2. Implementation Flow

  1. Understand - Study existing patterns in codebase
  2. Test - Write test first (red)
  3. Implement - Minimal code to pass (green)
  4. Refactor - Clean up with tests passing
  5. Commit - With clear message linking to plan

3. When Stuck (After 3 Attempts)

CRITICAL: Maximum 3 attempts per issue, then STOP.

  1. Document what failed:
  2. What you tried
  3. Specific error messages

  4. Why you think it failed

  5. Research alternatives:

  6. Find 2-3 similar implementations

  7. Note different approaches used

  8. Question fundamentals:

  9. Is this the right abstraction level?
  10. Can this be split into smaller problems?

  11. Is there a simpler approach entirely?

  12. Try different angle:

  13. Different library/framework feature?
  14. Different architectural pattern?
  15. Remove abstraction instead of adding?

Technical Standards

Architecture Principles

  • Composition over inheritance - Use dependency injection
  • Interfaces over singletons - Enable testing and flexibility
  • Explicit over implicit - Clear data flow and dependencies
  • Test-driven when possible - Never disable tests, fix them

Code Quality

  • Every commit must:
  • Compile successfully
  • Pass all existing tests
  • Include tests for new functionality

  • Follow project formatting/linting

  • Before committing:

  • Run formatters/linters
  • Self-review changes
  • Ensure commit message explains "why"

Error Handling

  • Fail fast with descriptive messages
  • Include context for debugging
  • Handle errors at appropriate level
  • Never silently swallow exceptions

Decision Framework

When multiple valid approaches exist, choose based on:

  1. Testability - Can I easily test this?
  2. Readability - Will someone understand this in 6 months?
  3. Consistency - Does this match project patterns?
  4. Simplicity - Is this the simplest solution that works?
  5. Reversibility - How hard to change later?

Project Integration

Learning the Codebase

  • Find 3 similar features/components
  • Identify common patterns and conventions
  • Use same libraries/utilities when possible
  • Follow existing test patterns

Tooling

  • Use project's existing build system
  • Use project's test framework
  • Use project's formatter/linter settings
  • Don't introduce new tools without strong justification

Dynamic Test Scheduling in CI/CD

This document outlines the architecture and implementation of the dynamic test scheduling system used in this project's CI/CD pipeline. The primary goal of this system is to dramatically reduce the time spent waiting for test feedback by intelligently selecting and running only the tests relevant to a given code change.

1. The Problem: Slow Feedback Loops

In a large monolithic application, the test suite can grow to thousands of tests, often taking 20 minutes or more to run. Running the entire suite for every minor change is inefficient and costly, leading to several problems:

  • Reduced Developer Velocity: Developers switch context while waiting for CI, slowing down the development cycle.
  • Increased CI/CD Costs: More runner time is consumed, leading to higher infrastructure costs.
  • Discourages Small Commits: Developers may be tempted to batch many changes into a single commit to avoid multiple long waits.

The ideal system provides feedback that is proportional to the risk of the change. A small bugfix in an isolated module should receive feedback in minutes, while a change to a core shared library rightly warrants a full, comprehensive test run.

2. The Solution: A Dynamic, Dependency-Aware Pipeline

Our solution is a dynamic pipeline generation system that operates in two main phases: a Planning Phase and an Execution Phase.

2.1. Core Concepts

  1. Dependency Graph: We statically analyze the Python source code to build a dependency graph of all Django applications. This graph answers the question: "If App A changes, which other apps (B, C, etc.) depend on it and might break?" This graph is stored in tests/dependency_graph.yaml and is version-controlled.
  2. Change Detection: For every merge request, we use Git to determine the exact set of files that have been modified.
  3. Test Selection: A Python script (tests/select_tests.py) combines the list of changed files with the dependency graph to produce a minimal list of applications that need to be tested.
  4. Dynamic Parallelization: We count the number of tests within the selected applications. Based on a pre-defined threshold, we dynamically decide how many parallel CI runners to allocate for the test run. Small batches of tests run on a single worker, while large batches are split across the maximum number of workers.
  5. Child Pipelines: GitLab's "parent-child pipeline" feature is used to implement this. A parent job does the planning and then triggers a child pipeline that is configured on-the-fly to match the required workload (e.g., a single job or 10 parallel jobs).

2.2. Workflow Visualization

The following diagram illustrates the complete end-to-end workflow for a typical merge request pipeline.

graph TD
    subgraph "Parent Pipeline"
        A[Start MR Pipeline] --> B{Merge Check}
        B -->|Success| C[generate_test_pipeline job]
        B -->|Failure| D[Fail Fast!]
        C --> E[tests/generate-pipeline.sh]
        E --> F[select_tests.py]
        F --> G{Full Run src?}
        G -->|Yes| H[Decide: Max Workers]
        G -->|No| I[pytest --collect-only]
        I --> J{Test Count > Threshold?}
        J -->|Yes| K[Decide: Scaled # of Workers]
        J -->|No| L[Decide: 1 Worker]
        H --> M[Generate artifacts]
        K --> M
        L --> M
        M --> N[run_tests_dynamically job]
    end

    subgraph "Child Pipeline"
        N -->|Triggers with TEST_PATHS| O[Test Jobs]
        O -->|1 worker| P[tests/waldur-test]
        O -->|N workers| P
        P --> Q[Execute Pytest]
        Q --> R[Upload Reports]
    end

    classDef success fill:#d4edda,stroke:#155724
    classDef failure fill:#f8d7da,stroke:#721c24
    classDef childPipeline fill:#cce5ff,stroke:#004085

    class A success
    class D failure
    class N,O childPipeline

3. Implementation Details

The system is composed of several key scripts and GitLab CI configuration files.

3.1. Core Scripts (Located in tests/)

  1. build_dependency_graph.py
  2. Purpose: To generate the dependency_graph.yaml file.
  3. How: It recursively finds all Django apps, parses their Python files using the ast module, and records all inter-app import statements.

  4. When to run: This script should be run manually and the result committed whenever new apps are added or major refactoring occurs.

  5. select_tests.py

  6. Purpose: To determine the list of applications to test for a given change.
  7. How: It reads the dependency_graph.yaml, gets the list of changed files from Git, and identifies the set of directly changed apps. It does not perform transitive dependency checks, for a balance of speed and safety.

  8. Special Case: If a "core" file (like pyproject.toml or .gitlab-ci.yml) is changed, it outputs the special string src to signal a full test run.

  9. generate-pipeline.sh

  10. Purpose: The main "brain" of the planning phase. It generates the child pipeline configuration.

  11. How:

    1. Calls select_tests.py.
    2. If the result is src, it immediately decides on maximum parallelization.
    3. Otherwise, it runs pytest --collect-only to get an exact test count.
    4. Based on the count and pre-defined thresholds, it determines the number of parallel workers needed.
    5. It writes a complete generated-pipeline.yml file, embedding the correct parallel: keyword and other variables.
    6. It also writes a generated_vars.env file to pass the selected test paths to the child pipeline.

  12. waldur-test

  13. Purpose: The final "executor" script that runs inside the child pipeline jobs.
  14. How: It's a simple, robust shell script that receives the test mode, test paths, and a splitting flag (true/false) as arguments. It constructs the final pytest command, adding the --test-group-* flags only if instructed to do so.

3.2. GitLab CI Configuration (.gitlab-ci.yml)

The main CI file implements a two-job pattern for the dynamic pipeline:

  1. generate_test_pipeline
  2. A non-parallel job that runs first.
  3. It performs the merge check to fail fast.
  4. It executes tests/generate-pipeline.sh.

  5. It saves generated-pipeline.yml and generated_vars.env as artifacts.

  6. run_tests_dynamically

  7. A non-script, trigger-only job.
  8. It needs the generate_test_pipeline job to ensure it runs second and has access to its artifacts.
  9. It uses trigger:include:artifact to start a child pipeline using the generated YAML.
  10. Crucially, it uses trigger:forward:yaml_variables:true to pass the TEST_PATHS variable to the child pipeline.

4. How to Maintain This System

  • Updating Dependencies: If you add a new Django app, run python tests/build_dependency_graph.py and commit the updated tests/dependency_graph.yaml.
  • Tuning Performance: The TEST_SPLITTING_THRESHOLD variable in tests/generate-pipeline.sh can be adjusted. If you find that small parallel jobs are inefficient, increase the threshold. If you have very fast-starting runners, you could decrease it.
  • Debugging: If a pipeline fails, first check the log of the generate_test_pipeline job. It contains detailed output about which paths were selected, how many tests were discovered, and what the generated child pipeline configuration looked like. This will usually pinpoint the source of the problem.

Add a new language for translatable models

For translating fields of some models we use django modeltranslation.

First run

To setup the database environment, after completing all migrations, execute in a console:

1
waldur update_translation_fields

Add a new language

To populate the generated language tables with initial content, run

1
waldur sync_translation_fields

How to write docs

Documentation for sysadmins

Documentation for sysadmins should contain a description of settings that allows to setup and customize Waldur MasterMind. It should be located in wiki.

Documentation for developers

If documentation describes basic concepts that are not related to any particular part of code it should be located in /docs folder. All other documentation for developers should be located in code.

Tips for writing docs:

  • add description for custom modules that are unique for particular plugin;
  • add description to base class methods that should be implemented by other developers;
  • don't add obvious comments for standard objects or parameters.

How to write serializers

This guide provides comprehensive patterns and best practices for writing serializers in Waldur MasterMind, based on analysis of the current codebase architecture.

Core Serializer Architecture Principles

Mixin-Based Composition

Waldur uses extensive mixin composition to build complex serializers with reusable functionality. The recommended order follows Python's Method Resolution Order (MRO):

1
2
3
4
5
6
7
class ResourceSerializer(
    DomainSpecificMixin,                    # e.g., SshPublicKeySerializerMixin
    core_serializers.RestrictedSerializerMixin,    # Field filtering
    PermissionFieldFilteringMixin,          # Security filtering
    core_serializers.AugmentedSerializerMixin,     # Core extensions
    serializers.HyperlinkedModelSerializer,        # DRF base
):

Key Mixin Classes

  1. AugmentedSerializerMixin: Core functionality for signal injection and related fields
  2. RestrictedSerializerMixin: Field-level control to avoid over-fetching
  3. PermissionFieldFilteringMixin: Security filtering based on user permissions
  4. SlugSerializerMixin: Slug field management with staff-only editing
  5. CountrySerializerMixin: Internationalization support

Object Identity and HATEOAS

UUID-Based Identity

All objects are identified by UUIDs rather than database IDs for distributed database support:

1
2
3
4
5
6
project = serializers.HyperlinkedRelatedField(
    queryset=models.Project.objects.all(),
    view_name='project-detail',
    lookup_field='uuid',  # Always use UUID
    write_only=True
)

Consistent URL Patterns

  • Detail views: {model_name}-detail
  • List views: {model_name}-list
  • Custom actions: {model_name}-{action}
1
2
3
4
5
6
class Meta:
    extra_kwargs = {
        "url": {"lookup_field": "uuid"},
        "customer": {"lookup_field": "uuid"},
        "project": {"lookup_field": "uuid", "view_name": "project-detail"},
    }

Use related_paths to automatically generate related object fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
class ProjectSerializer(core_serializers.AugmentedSerializerMixin, ...):
    class Meta:
        model = models.Project
        fields = (
            'url', 'uuid', 'name', 'customer',
            'customer_uuid', 'customer_name', 'customer_native_name'
        )
        related_paths = {
            'customer': ('uuid', 'name', 'native_name', 'abbreviation'),
            'type': ('name', 'uuid'),
        }

This automatically generates: customer_uuid, customer_name, customer_native_name, customer_abbreviation, etc.

Security and Permissions

Permission-Based Field Filtering

Always use PermissionFieldFilteringMixin for related fields to ensure users can only reference objects they have access to:

1
2
3
class ResourceSerializer(PermissionFieldFilteringMixin, ...):
    def get_filtered_field_names(self):
        return ('project', 'service_settings', 'customer')

Permission List Serializers

For many=True relationships, use PermissionListSerializer:

1
2
3
class PermissionProjectSerializer(BasicProjectSerializer):
    class Meta(BasicProjectSerializer.Meta):
        list_serializer_class = PermissionListSerializer

Staff-Only Fields

Restrict sensitive fields to staff users:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
class Meta:
    staff_only_fields = (
        "access_subnets", "accounting_start_date",
        "default_tax_percent", "backend_id"
    )

def get_fields(self):
    fields = super().get_fields()
    if not self.context['request'].user.is_staff:
        for field_name in self.Meta.staff_only_fields:
            if field_name in fields:
                fields[field_name].read_only = True
    return fields

Protected Fields

Use protected_fields to make fields read-only during updates:

1
2
class Meta:
    protected_fields = ("customer", "service_settings", "end_date_requested_by")

Performance Optimization

Eager Loading

Always implement eager_load() static methods for query optimization:

1
2
3
4
5
6
7
8
9
@staticmethod
def eager_load(queryset, request=None):
    return queryset.select_related(
        'customer', 'project', 'service_settings'
    ).prefetch_related(
        'security_groups', 'volumes', 'floating_ips'
    ).only(
        'uuid', 'name', 'created', 'customer__uuid', 'customer__name'
    )

RestrictedSerializerMixin Documentation

The RestrictedSerializerMixin provides a powerful and flexible way to dynamically control which fields are rendered by a Django REST Framework serializer based on query parameters in the request URL. This is especially useful for optimizing API responses, reducing payload size, and allowing API clients to fetch only the data they need.

The mixin supports two primary modes of operation:

  • Restricted Field Rendering (Whitelisting): The client specifies exactly which fields they want, and all others are excluded.
  • Optional Fields (Blacklisting by Default): The serializer defines certain "expensive" or non-essential fields that are excluded by default but can be explicitly requested by the client.

Basic Usage

To use the mixin, simply add it to your serializer's inheritance list. The mixin requires the request object to be in the serializer's context, which DRF views typically provide automatically.

1
2
3
4
5
6
7
from .mixins import RestrictedSerializerMixin
from rest_framework import serializers

class CustomerSerializer(RestrictedSerializerMixin, serializers.ModelSerializer):
    class Meta:
        model = Customer
        fields = ('uuid', 'name', 'email', 'created', 'projects_count')

Feature 1: Restricted Field Rendering (Whitelisting)

This is the primary feature. By adding the ?field= query parameter to the URL, an API client can request a specific subset of fields. The serializer will only render the fields present in the field parameters.

Example: Imagine a CustomerSerializer with the fields uuid, name, email, and created.

To request only the name and uuid of a customer: URL: /api/customers/123/?field=name&field=uuid

Expected JSON Response:

1
2
3
4
{
  "name": "Acme Corp",
  "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Feature 2: Optional Fields (Blacklisting by Default)

Some fields can be expensive to compute (e.g., involving extra database queries, aggregations, or external API calls). You can mark these fields as "optional" by overriding the get_optional_fields method. These fields will not be included in the response unless they are explicitly requested via the ?field= parameter.

Example: Let's add projects (a related field) and billing_price_estimate (a computed field) to our serializer and mark them as optional.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
class CustomerSerializer(RestrictedSerializerMixin, serializers.ModelSerializer):
    projects = ProjectSerializer(many=True, read_only=True)
    billing_price_estimate = serializers.SerializerMethodField()

    class Meta:
        model = Customer
        fields = ('uuid', 'name', 'email', 'created', 'projects', 'billing_price_estimate')

    def get_optional_fields(self):
        # These fields will be excluded unless explicitly requested.
        return ['projects', 'billing_price_estimate']

    def get_billing_price_estimate(self, obj):
        # ... some expensive calculation ...
        return calculate_price(obj)

Behavior Examples

Standard Request

URL: /api/customers/123/

Result: The optional fields (projects, billing_price_estimate) are excluded. The expensive get_billing_price_estimate method is never called.

1
2
3
4
5
6
{
  "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Acme Corp",
  "email": "contact@acme.corp",
  "created": "2023-10-27T10:00:00Z"
}

Requesting Optional Fields

URL: /api/customers/123/?field=name&field=projects

Result: The response is restricted to name, and the optional field projects is included because it was requested.

1
2
3
4
5
6
7
{
  "name": "Acme Corp",
  "projects": [
    { "name": "Project X" },
    { "name": "Project Y" }
  ]
}

Advanced Behavior

Nested Serializers

The RestrictedSerializerMixin is designed to be "nesting-aware." It will only apply its filtering logic to the top-level serializer in a request. Any nested serializers will be rendered completely, ignoring the ?field= parameters from the URL. This prevents unintentional and undesirable filtering of nested data structures.

Example: A ProjectSerializer that includes a nested CustomerSerializer.

URL: /api/projects/abc/?field=name&field=customer

Expected JSON Response: The ProjectSerializer is filtered to name and customer. The nested CustomerSerializer, however, renders all of its fields (excluding its own optional fields, of course), because it is not the top-level serializer.

1
2
3
4
5
6
7
8
9
{
  "name": "Project X",
  "customer": {
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "Acme Corp",
    "email": "contact@acme.corp",
    "created": "2023-10-27T10:00:00Z"
  }
}

List Views (many=True)

The mixin works seamlessly with list views. The field filtering is applied individually to each object in the list.

Example: URL: /api/customers/?field=uuid&field=name

Expected JSON Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
  {
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "Acme Corp"
  },
  {
    "uuid": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
    "name": "Stark Industries"
  }
]

Complex Validation Patterns

Hierarchical Validation

Implement validation in layers:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
def validate(self, attrs):
    # 1. Cross-field validation
    self.validate_cross_field_constraints(attrs)

    # 2. Permission validation
    if attrs.get('end_date'):
        if not has_permission(self.context['request'],
                             PermissionEnum.DELETE_PROJECT,
                             attrs.get('customer')):
            raise exceptions.PermissionDenied()

    # 3. Business rule validation
    self.validate_business_rules(attrs)

    return attrs

Dynamic Field Behavior

Use get_fields() for context-dependent field behavior:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
def get_fields(self):
    fields = super().get_fields()

    # Time-based restrictions
    if (isinstance(self.instance, models.Project)
        and self.instance.start_date
        and self.instance.start_date < timezone.now().date()):
        fields["start_date"].read_only = True

    # Role-based restrictions
    if not self.context["request"].user.is_staff:
        fields["max_service_accounts"].read_only = True

    return fields

External API Integration

For external validation (e.g., VAT numbers):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
def validate(self, attrs):
    vat_code = attrs.get('vat_code')
    country = attrs.get('country')

    if vat_code:
        # Format validation
        if not pyvat.is_vat_number_format_valid(vat_code, country):
            raise serializers.ValidationError(
                {"vat_code": _("VAT number has invalid format.")}
            )

        # External API validation
        check_result = pyvat.check_vat_number(vat_code, country)
        if check_result.is_valid:
            attrs["vat_name"] = check_result.business_name
            attrs["vat_address"] = check_result.business_address
        elif check_result.is_valid is False:
            raise serializers.ValidationError(
                {"vat_code": _("VAT number is invalid.")}
            )

    return attrs

Service Configuration Patterns

Options Pattern for Flexible Configuration

Use the options pattern for service-specific configuration without model changes:

1
2
3
4
5
6
7
8
class OpenStackServiceSerializer(structure_serializers.ServiceOptionsSerializer):
    class Meta:
        secret_fields = ("backend_url", "username", "password", "certificate")

    # Map to options.* for flexible storage
    availability_zone = serializers.CharField(source="options.availability_zone")
    dns_nameservers = serializers.ListField(source="options.dns_nameservers")
    external_network_id = serializers.CharField(source="options.external_network_id")

Secret Field Management

Protect sensitive configuration data:

1
2
class Meta:
    secret_fields = ("password", "certificate", "private_key", "api_token")

Complex Resource Orchestration

Transactional Resource Creation

For resources that create multiple related objects:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
@transaction.atomic
def create(self, validated_data):
    # Extract sub-resource data
    quotas = validated_data.pop("quotas", {})
    subnet_cidr = validated_data.pop("subnet_cidr")

    # Create main resource
    resource = super().create(validated_data)

    # Create related resources
    self._create_default_network(resource, subnet_cidr)
    self._create_security_groups(resource)
    self._apply_quotas(resource, quotas)

    return resource

def _create_default_network(self, resource, cidr):
    # Implementation with proper error handling
    pass

Advanced Serializer Patterns

Nested Resource Serializers

For complex relationships:

1
2
3
4
5
6
7
8
class OpenStackInstanceSerializer(structure_serializers.VirtualMachineSerializer):
    security_groups = OpenStackNestedSecurityGroupSerializer(many=True, required=False)
    floating_ips = OpenStackNestedFloatingIPSerializer(many=True, required=False)
    volumes = OpenStackDataVolumeSerializer(many=True, required=False)

    def validate_security_groups(self, security_groups):
        # Validate security groups belong to same tenant
        return security_groups

Generic Relationships

For polymorphic relationships:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
scope = core_serializers.GenericRelatedField(
    related_models=structure_models.BaseResource.get_all_models(),
    required=False,
    allow_null=True,
)

# In model:
resource_content_type = models.ForeignKey(ContentType, ...)
resource_object_id = models.PositiveIntegerField(...)
resource = GenericForeignKey('resource_content_type', 'resource_object_id')

Signal-Based Field Injection

Extensible Serializers

Avoid circular dependencies by using signals for field injection:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Host serializer
class ProjectSerializer(core_serializers.AugmentedSerializerMixin, ...):
    pass

# Guest application injects fields
def add_marketplace_resource_uuid(sender, fields, **kwargs):
    fields["marketplace_resource_uuid"] = serializers.SerializerMethodField()
    setattr(sender, "get_marketplace_resource_uuid", get_marketplace_resource_uuid)

core_signals.pre_serializer_fields.connect(
    sender=structure_serializers.ProjectSerializer,
    receiver=add_marketplace_resource_uuid,
)

Standard Meta Class Configuration

Complete Meta Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
class Meta:
    model = models.MyModel
    fields = (
        "url", "uuid", "name", "customer", "customer_uuid", "customer_name",
        "created", "description", "state", "backend_id"
    )
    extra_kwargs = {
        "url": {"lookup_field": "uuid"},
        "customer": {"lookup_field": "uuid"},
    }
    related_paths = {
        "customer": ("uuid", "name", "native_name"),
    }
    protected_fields = ("customer", "backend_id")
    staff_only_fields = ("backend_id", "internal_notes")
    list_serializer_class = PermissionListSerializer  # For many=True

Custom Field Types

Specialized Fields

  • HTMLCleanField: Automatically sanitizes HTML content
  • DictSerializerField: Handles JSON dictionary serialization
  • GenericRelatedField: Supports multiple model types in relations
  • MappedChoiceField: Maps choice values for API consistency
1
2
3
4
5
6
7
description = core_serializers.HTMLCleanField(required=False, allow_blank=True)
options = serializers.DictField()
state = MappedChoiceField(
    choices=[(v, k) for k, v in CoreStates.CHOICES],
    choice_mappings={v: k for k, v in CoreStates.CHOICES},
    read_only=True,
)

Testing Serializers

Factory-Based Testing

Use factory classes for test data generation:

1
2
3
4
5
6
7
8
def test_project_serializer():
    project = factories.ProjectFactory()
    serializer = ProjectSerializer(project)
    data = serializer.data

    assert 'customer_uuid' in data
    assert 'customer_name' in data
    assert data['url'].endswith(f'/api/projects/{project.uuid}/')

Permission Testing

Test permission-based filtering:

1
2
3
4
5
6
7
8
def test_permission_filtering(self, user):
    customer = factories.CustomerFactory()
    project = factories.ProjectFactory(customer=customer)

    # User with no permissions should not see the project
    serializer = ProjectSerializer(context={'request': rf.get('/', user=user)})
    queryset = serializer.fields['customer'].queryset
    assert customer not in queryset

Common Pitfalls and Best Practices

Do's

  1. Always use UUID lookup fields for all hyperlinked relationships
  2. Implement eager_load() for any serializer used in list views
  3. Use PermissionFieldFilteringMixin for all related fields
  4. Follow the mixin order for consistent behavior
  5. Use related_paths for automatic related field generation
  6. Implement comprehensive validation at multiple levels
  7. Use transactions for multi-resource creation
  8. Mark expensive fields as optional

Don'ts

  1. Don't use fields = '__all__' - always be explicit
  2. Don't forget lookup_field='uuid' in extra_kwargs
  3. Don't skip permission filtering for security-sensitive fields
  4. Don't implement custom field logic without using established patterns
  5. Don't create circular dependencies - use signal injection instead
  6. Don't ignore performance - always consider query optimization
  7. Don't hardcode view names - use consistent naming patterns

Migration from Legacy Patterns

Updating Existing Serializers

When updating legacy serializers:

  1. Add missing mixins in the correct order
  2. Implement eager_load() static methods
  3. Add related_paths for automatic field generation
  4. Add permission filtering with get_filtered_field_names()
  5. Use protected_fields instead of custom read-only logic
  6. Update to use lookup_field='uuid' consistently

This comprehensive guide provides the patterns and practices needed to write maintainable, secure, and performant serializers that follow Waldur's architectural conventions.

How to write tests

Application tests structure

Application tests should follow next structure:

  • /tests/ - folder for all application tests.

  • /tests/test_my_entity.py - file for API calls tests that are logically related to entity. Example: test calls for project CRUD + actions.

  • /tests/test_my_entity.py:MyEntityActionTest - class for tests that are related to particular endpoint. Examples: ProjectCreateTest, InstanceResizeTest.

  • /tests/unittests/ - folder for unittests of particular file.

  • /tests/unittests/test_file_name.py - file for test of classes and methods from application file "file_name". Examples: test_models.py, test_handlers.py.

  • /tests/unittests/test_file_name.py:MyClassOrFuncTest - class for test that is related to particular class or function from file. Examples: ProjectTest, ValidateServiceTypeTest.

Tips for writing tests

  • cover important or complex functions and methods with unittests;
  • write at least one test for a positive flow for each endpoint;
  • do not write tests for actions that does not exist. If you don't support "create" action for any user there is no need to write test for that;
  • use fixtures (module fixtures.py) to generate default structure.

How to override settings in unit tests

Don't manipulate django.conf.settings directly as Django won't restore the original values after such manipulations. Instead you should use standard context managers and decorators. They change a setting temporarily and revert to the original value after running the testing code. If you modify settings directly, you break test isolation by modifying global variable.

If configuration setting is not plain text or number but dictionary, and you need to update only one parameter, you should take whole dict, copy it, modify parameter, and override whole dict.

Wrong:

1
2
  with self.settings(WALDUR_CORE={'INVITATION_LIFETIME': timedelta(weeks=1)}):
    tasks.cancel_expired_invitations()

Right:

1
2
3
4
5
  waldur_settings = settings.WALDUR_CORE.copy()
  waldur_settings['INVITATION_LIFETIME'] = timedelta(weeks=1)

  with self.settings(WALDUR_CORE=waldur_settings):
    tasks.cancel_expired_invitations()

Running tests

In order to run unit tests for specific module please execute the following command. Note that you should substitute module name instead of example waldur_openstack. Also it is assumed that you've already activated virtual Python environment.

1
  DJANGO_SETTINGS_MODULE=waldur_core.server.test_settings waldur test waldur_openstack

How to write views

View workflow

  • Filtering - filter objects that are visible to a user based on his request. Raise 404 error if object is not visible.

  • Permissions check - make sure that user has right to execute chosen action. Raise 403 error if user does not have enough permissions.

  • View validation - check object state and make sure that selected action can be executed. Raise 409 error if action cannot be executed with current object state.

  • Serializer validation - check that user's data is valid.

  • Action logic execution - do anything that should be done to execute action. For example: schedule tasks with executors, run backend tasks, save data to DB.

  • Serialization and response output - return serialized data as response.

Installation Guide

Installation via Dev Containers

If you use VS Code or GitHub Codespaces, you can quickly set up a development environment using Dev Containers. This method provides a consistent, pre-configured environment with all necessary dependencies.

Prerequisites for Dev Containers are:

After cloning repository, when prompted "Reopen in Container", click on it. Alternatively, you can press Ctrl+Shift+P, type "Dev Containers: Reopen in Container" and press Enter.

VS Code will build the dev container and set up the environment automatically. This process includes:

  • Installing all system dependencies
  • Setting up Python with the correct version
  • Installing VS Code extensions
  • Installing uv and project dependencies
  • Installing PostgreSQL
  • Configuring pre-commit hooks

Once the container is built and running, you'll have a fully configured development environment ready to use.

Installation from source

Prerequisites

  • Linux OS. If you use Windows, you should install Linux either via Virtualbox or Windows Subsystem for Linux.
  • git
  • virtualenv
  • C compiler and development libraries needed to build dependencies

Package installation by OS

  • Debian or Ubuntu: sudo apt install git python3-pip python3-venv python3-dev gcc libffi-dev libsasl2-dev libssl-dev libpq-dev libjpeg8-dev zlib1g-dev xmlsec1 libldap2-dev liblzma-dev libxslt1-dev libxml2-dev libbz2-dev libreadline-dev libsqlite3-dev

  • OS X: brew install openssl; export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"; export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"

Installation steps

Install uv

1
curl -LsSf https://astral.sh/uv/install.sh | sh

Install pyenv

1
2
3
curl https://pyenv.run | bash
pyenv install 3.11.9
pyenv global 3.11.9

Get the code

1
2
git clone https://github.com/waldur/waldur-mastermind.git
cd waldur-mastermind

Install Waldur in development mode

1
2
3
uv sync --dev
uv pip install -e .
uv run pre-commit install

NB: If you use a machine with Apple M1 CPU, run this before:

1
2
3
4
export optflags="-Wno-error=implicit-function-declaration"
export LDFLAGS="-L/opt/homebrew/opt/libffi/lib"
export CPPFLAGS="-I/opt/homebrew/opt/libffi/include"
export PKG_CONFIG_PATH="/opt/homebrew/opt/libffi/lib/pkgconfig"

Create and edit settings file

1
2
cp src/waldur_core/server/settings.py.example src/waldur_core/server/settings.py
vi src/waldur_core/server/settings.py

Database setup

Initialize PostgreSQL database:

1
2
3
sudo -u postgres -i
createdb waldur
createuser waldur

Add a password waldur for this user:

1
2
3
psql
ALTER USER waldur PASSWORD 'waldur';
ALTER DATABASE waldur OWNER TO waldur;

Final Setup Steps

Run migrations:

1
uv run waldur migrate --noinput

Collect static files:

1
uv run waldur collectstatic --noinput

Start Waldur:

1
uv run waldur runserver

Additional configuration

For detailed configuration instructions, visit https://docs.waldur.com/latest/admin-guide/mastermind-configuration/general/

Developer's Guide to OpenAPI Schema Generation in Waldur

This document provides an in-depth explanation of our approach to generating a high-quality OpenAPI 3 schema for the Waldur API using drf-spectacular. A well-defined schema is critical for API documentation, client generation, automated testing, and providing a clear contract for our API consumers.

We heavily customize drf-spectacular's default behavior to produce a schema that is not only accurate but also rich with metadata, developer-friendly, and reflective of Waldur's specific architecture and conventions.

1. Architectural Overview

drf-spectacular generates a schema by introspecting your Django Rest Framework project. Our customizations hook into this process at four key stages, each handled by a different component:

Component File Responsibility When to Use
Endpoint Enumerator openapi_generators.py Discovering Endpoints. Controls which API endpoints and methods are included in the schema. When you need to globally filter out views or methods based on a project-specific convention (e.g., a disabled_actions property on a viewset).
Schema Inspector (AutoSchema) openapi_inspector.py Analyzing Individual Endpoints. The main workhorse. It inspects a single view/method to determine its parameters, request/response bodies, description, operation ID, and other details. For the majority of customizations related to a specific endpoint's representation, like adding custom parameters, modifying descriptions, or adding vendor extensions.
Extensions openapi_extensions.py Handling Custom Components. Provides explicit schema definitions for custom classes (Authentication, Serializer Fields, Serializers) that drf-spectacular cannot introspect automatically. When you have a reusable custom class (e.g., GenericRelatedField) that needs a consistent representation across the entire schema.
Post-processing Hooks schema_hooks.py Modifying the Final Schema. Functions that run on the fully generated schema just before it's rendered. They are used for global search-and-replace operations, refactoring, and complex structural changes. For broad, cross-cutting changes like adding a header to all list endpoints, refactoring common parameters into components, or implementing complex polymorphic schemas.

The generation process flows like this: Enumerator → Inspector (for each endpoint) → Extensions (as needed by Inspector) → Schema Hooks → Final OpenAPI YAML/JSON

2. The Core Inspector: WaldurOpenApiInspector

This class, located in openapi_inspector.py, is our custom subclass of AutoSchema and contains the most significant logic for tailoring the schema endpoint-by-endpoint.

Key Methods and Use-Cases

resolve_serializer(...)

  • Purpose: To ensure that when a serializer is instantiated during schema generation, it's aware of this context.
  • Mechanism: It calls the parent method and then sets a flag _is_generating_schema = True on the mock request object within the serializer's context.
  • Design Rationale: Several of our custom serializers change their behavior based on this flag. For example, RestrictedSerializerMixin might include all its fields, even optional ones, if this flag is set. This gives API consumers a complete picture of all possible data they could receive.

get_operation(...)

  • Purpose: To enrich the generated "operation" object with Waldur-specific metadata and logic.

  • Edge Cases Handled:

    1. HEAD method for Lists: We map the HEAD HTTP method to a "count" operation for list views. The inspector provides a custom description and a simple 200 response. Crucially, it returns None for detail views (/api/users/{uuid}/), effectively hiding this non-sensical operation.
    2. Custom Permissions Metadata: This is a powerful feature for our frontend developers. If a view action has a _permissions attribute (e.g., create_permissions), the inspector extracts this data and injects it into the schema under a custom x-permissions vendor extension. This allows the frontend to understand the permissions required for an action without hardcoding them.
    1
2
3
4
5
6
7
    # Example Output
"/api/projects/":
  post:
    summary: "Create a new project"
    x-permissions:
      - permission: "project.create"
        scopes: ["customer"]

get_description()

  • Purpose: To pull the docstring from the correct viewset action (create, retrieve, my_action) rather than from the view class itself.
  • Convention: Developers must write clear, concise docstrings on viewset action methods. These docstrings are what users will see in the API documentation.

get_operation_id()

  • Purpose: To generate clean, predictable, and code-generator-friendly operation IDs.
  • Convention: The default behavior is modified to produce IDs like projects_list, projects_create, projects_retrieve. A special case for non-create POST actions (e.g., custom actions) uses a shorter format to avoid redundancy. This consistency is vital for generated API clients.

get_override_parameters()

  • Purpose: To dynamically add query parameters based on the response serializer.
  • Use-Case: Our RestrictedSerializerMixin allows users to request a subset of fields via the field query parameter (e.g., ?field=name&field=uuid). This method introspects the response serializer, gets all its possible field names, and automatically generates the OpenApiParameter for field with a complete enum of available values. This provides excellent auto-complete and validation in tools like Swagger UI.

_postprocess_serializer_schema(...)

  • Purpose: To modify a serializer's schema after it has been generated.
  • Use-Case: Our serializers can have an optional_fields override. This method respects that override by removing those fields from the required array in the final schema. This is a clean way to tweak serializer requirements for the API without complex serializer inheritance.

3. Specialized Handlers: Extensions

Located in openapi_extensions.py, these classes provide a modular way to handle custom components.

  • WaldurTokenScheme, WaldurSessionScheme, OIDCAuthenticationScheme: These extensions map our custom DRF authentication classes to standard OpenAPI security schemes. This is the correct way to document API authentication.
  • GenericRelatedFieldExtension:
  • Problem: drf-spectacular doesn't know how to represent our custom GenericRelatedField.
  • Solution: This extension tells the generator to simply represent it as a string (which, in our case, is a URL). This avoids schema generation errors and provides a simple, accurate representation.
  • OpenStackNestedSecurityGroupSerializerExtension:
    • Problem: A specific nested serializer is overly complex, and for the API schema, we only want to show a simplified version of it.
    • Solution: This extension bypasses introspection of the serializer entirely and provides a fixed, hardcoded schema ({"type": "object", "properties": {"url": ...}}). This is an excellent technique for simplifying complex nested objects in the API documentation.

4. Endpoint Discovery: WaldurEndpointEnumerator

Located in openapi_generators.py, this class controls which endpoints are included in the schema.

  • Purpose: The default enumerator might include all possible HTTP methods that a view could support. Our WaldurEndpointEnumerator is smarter.
  • Mechanism: It respects the disabled_actions list property on our viewsets. If an action (e.g., 'destroy') is in disabled_actions, the corresponding method (DELETE) will be excluded from the schema for that endpoint.
  • Convention: To disable an API endpoint, add its action name to the disabled_actions list on the ViewSet. The API documentation will automatically update to reflect this.

5. Global Transformations: Schema Hooks

Located in schema_hooks.py, these functions perform powerful, sweeping modifications to the entire generated schema. They are the last step in the process.

  • Design Principle: Use hooks for cross-cutting concerns that affect many endpoints, or for complex transformations that are difficult to achieve within the inspector.

Key Hooks and Their Purpose

  • refactor_pagination_parameters:
  • Best Practice: This hook implements the DRY (Don't Repeat Yourself) principle. It finds all instances of page and page_size parameters, moves their definition to the global #/components/parameters/ section, and replaces the inline definitions with $ref pointers. This reduces schema size and improves consistency.
  • add_result_count_header:
    • Purpose: To document that all our paginated list endpoints return the x-result-count header.
    • Mechanism: It identifies list endpoints (by checking if operationId ends in _list), defines a reusable header in #/components/headers/, and adds a reference to it in the 2xx responses of those endpoints.
  • make_fields_optional:
    • Problem: Endpoints using RestrictedSerializerMixin can return a variable subset of fields. How do we represent this?
    • Solution: This hook finds any operation that has a field query parameter. For those operations, it recursively traverses their response schemas and removes the required property from all objects. This correctly signals to API consumers that any field might be absent if not explicitly requested.
  • transform_paginated_arrays:
    • Purpose: To simplify the schema structure for paginated responses.
    • Mechanism: drf-spectacular often creates named components like PaginatedUserList. This hook finds all such components, inlines their array definition wherever they are referenced, and then removes the original component definition. The result is a slightly more verbose but flatter and often easier-to-understand schema for the end-user.
  • add_polymorphic_attributes_schema:
    • This is the most advanced and powerful hook in our arsenal.
    • Problem: The attributes field on the "Create Order" endpoint is polymorphic. Its structure depends entirely on the offering_type of the marketplace offering.
    • Solution: We use OpenAPI's oneOf keyword to represent this polymorphism.
    • Mechanism: The hook acts as a pre-processing step. It dynamically:
      1. Iterates through all registered marketplace plugins (waldur_mastermind.marketplace.plugins).
      2. For each plugin, it finds the serializer responsible for validating the attributes field.
      3. It uses a temporary AutoSchema instance to generate a schema for that specific serializer's fields.
      4. It adds this generated schema to #/components/schemas/ with a unique name (e.g., OpenStackInstanceCreateOrderAttributes).
      5. Finally, it modifies the OrderCreateRequest schema to replace the attributes field with a oneOf that references all the dynamically generated schemas, plus a generic fallback.
    • Architectural Significance: This demonstrates how hooks can be used to generate schema fragments dynamically by introspecting parts of the application (in this case, the plugin system) that are outside the immediate scope of a DRF view.
  • Other Hooks: postprocess_drop_description, postprocess_fix_enum, remove_waldur_cookie_auth, adjust_request_body_content_types are utility hooks for cleaning up and standardizing the final output.

6. Query Parameters and Enum Definitions

Ordering Parameters

When implementing ordering functionality for API endpoints, proper OpenAPI schema documentation is crucial for API consumers. Waldur uses the convention of o as the ordering parameter name (configured in ORDERING_PARAM).

Best Practice: Explicit Enum Definitions

Instead of using a generic str type for ordering parameters, define explicit enums that list all supported ordering fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@extend_schema(
    parameters=[
        OpenApiParameter(
            "o",
            {"type": "string", "enum": [
                "project_name", "-project_name",
                "resource_name", "-resource_name",
                "provider_name", "-provider_name",
                "name", "-name"
            ]},
            OpenApiParameter.QUERY,
            description="Order results by field",
        ),
    ],
)
@action(detail=True)
def items(self, request, uuid=None):
    # Implementation...

This approach generates proper OpenAPI schema:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
- in: query
  name: o
  schema:
    type: string
    enum:
    - project_name
    - -project_name
    - resource_name
    - -resource_name
    - provider_name
    - -provider_name
    - name
    - -name
  description: Order results by field

Benefits

  • API Documentation: Clear enumeration of supported ordering fields
  • Client Generation: Generated clients include proper validation and auto-completion
  • Frontend Integration: UI components can dynamically generate ordering controls
  • API Testing: Testing tools can validate ordering parameters automatically

Implementation Pattern

  1. Define the enum schema in the @extend_schema decorator
  2. Include both ascending and descending options (prefix with - for descending)
  3. Map to database fields in your filtering logic:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
def filter_invoice_items(items, ordering=None):
    if ordering:
        ordering_map = {
            'project_name': 'project_name',
            '-project_name': '-project_name',
            'resource_name': 'resource__name',
            '-resource_name': '-resource__name',
            # ... more mappings
        }

        db_ordering = ordering_map.get(ordering)
        if db_ordering:
            items = core_utils.order_with_nulls(items, db_ordering)

    return items

7. Best Practices and Conventions

  1. Docstrings are the Source of Truth: Write clear docstrings on viewset action methods. They become the official API descriptions.
  2. Use the Right Tool for the Job:
  3. View-specific logic? Use the WaldurOpenApiInspector.
  4. Reusable custom class? Create an Extension.
  5. Global rule for filtering endpoints? Modify the WaldurEndpointEnumerator.
  6. Schema-wide refactoring or complex polymorphism? Write a postprocessing_hook.
  7. Leverage View Attributes for Metadata: We use view attributes like create_permissions and disabled_actions to control schema generation. This co-locates API behavior and its documentation, making the code easier to maintain.
  8. Define Explicit Enums for Query Parameters: For parameters like ordering (o), filtering, or status selection, always define explicit enum values in the schema instead of generic string types. This provides better documentation, client generation, and validation.
  9. Embrace Vendor Extensions (x-): For custom metadata that doesn't fit the OpenAPI standard (like our x-permissions), vendor extensions are the correct and standard way to include it.
  10. Strive for DRY Schemas: Use hooks like refactor_pagination_parameters to create reusable components (parameters, headers, schemas). This keeps the schema clean and consistent.
  11. Handle Polymorphism with Hooks: For complex conditional schemas (oneOf, anyOf), post-processing hooks are the most flexible and powerful tool available, as demonstrated by add_polymorphic_attributes_schema.
  12. Simplify for the Consumer: Use extensions (OpenStackNestedSecurityGroupSerializerExtension) and hooks (transform_paginated_arrays) to simplify complex or deeply nested objects where the full detail is unnecessary for the API consumer. The goal is a schema that is not just accurate, but also usable.

8. The OpenAPI Schema in the Broader Workflow

The OpenAPI schema is not merely a documentation artifact; it is a critical, machine-readable contract that drives a significant portion of our development, testing, and release workflows. Our CI/CD pipelines are built around the schema as the single source of truth for the API's structure.

The entire automated process is defined in the GitLab CI configurations for the waldur-mastermind and waldur-docs repositories.

1. Automated Generation

The process begins in the waldur-mastermind pipeline in a job named Generate OpenAPI schema.

  • Triggers: This job runs automatically in two scenarios:
    1. On a schedule for the develop branch: This ensures we always have an up-to-date schema reflecting the latest development state.
    2. When a version tag is pushed (e.g., 1.2.3): This generates a stable, versioned schema for a specific release.
  • Output: The job produces a versioned waldur-openapi-schema.yaml file, which is stored as a CI artifact. This artifact becomes the input for all subsequent steps.

2. Automated SDK and Tooling Generation

The generated schema artifact immediately triggers a series of parallel jobs, each responsible for generating a specific client SDK or tool. This "schema-first" approach ensures that our client libraries are always perfectly in sync with the API they are meant to consume.

  • Generate TypeScript SDK: For Waldur HomePort and other web frontends.
  • Generate Python SDK: For scripting, integrations, and internal tools.
  • Generate Go SDK: For command-line tools and backend services.
  • Generate Terraform SDK: Creates a Terraform provider for infrastructure-as-code management of Waldur resources.
  • Generate Ansible modules: Creates Ansible collections for configuration management and automation.

3. Continuous Delivery of SDKs

For development builds (from the develop branch), the newly generated SDKs are automatically committed and pushed to the main or develop branch of their respective GitHub repositories. This provides a continuous delivery pipeline for our API clients, allowing developers to immediately access and test the latest API changes through their preferred language.

4. Release and Versioning Workflow

For tagged releases, the workflow is more extensive:

  1. API Diff Generation: A job named Generate OpenAPI schema diff is triggered. It fetches the schema of the previous release from the waldur-docs repository and compares it against the newly generated schema using oasdiff. It produces a human-readable Markdown file (openapi-diff.md) detailing exactly what has changed (endpoints added, fields removed, etc.).
  2. Documentation Deployment: The new versioned schema (waldur-openapi-schema-1.2.3.yaml) and the diff file are automatically committed to the waldur-docs repository. The documentation site is then rebuilt, archiving the new schema and making the API changes visible in the release notes.
  3. Changelog Integration: The main CHANGELOG.md in the waldur-docs repository is automatically updated with links to the new schema file and the API diff page. This provides unparalleled clarity for integrators, showing them precisely what changed in a new release.
  4. SDK Release: The tagged version of each SDK is released, often involving bumping the version in configuration files (pyproject.toml, package.json) and pushing a corresponding version tag to the SDK's repository.

This automated, schema-driven workflow provides immense benefits:

  • Consistency: All clients and documentation are generated from the same source, eliminating discrepancies.
  • Speed: Developers get up-to-date SDKs without manual intervention, accelerating the development cycle.
  • Reliability: The risk of human error in writing client code or documenting changes is significantly reduced.
  • Clarity: Release notes are precise and automatically generated, giving integrators clear instructions on what to expect.

Declaring resource actions

Any methods on the resource viewset decorated with @action(detail=True, methods=['post']) will be recognized as resource actions. For example:

1
2
3
4
5
6
7
8
9
class InstanceViewSet(structure_views.BaseResourceViewSet):

    @action(detail=True, methods=['post'])
    def start(self, request, uuid=None):
        pass

    @action(detail=True, methods=['post'])
    def unlink(self, request, uuid=None):
        pass

Complex actions and serializers

If your action uses serializer to parse complex data, you should declare action-specific serializers on the resource viewset. For example:

1
2
3
4
class InstanceViewSet(structure_views.BaseResourceViewSet):

    assign_floating_ip_serializer_class = serializers.AssignFloatingIpSerializer
    resize_serializer_class = serializers.InstanceResizeSerializer

Waldur Django Architecture

Project Structure Overview

Waldur MasterMind is a Django-based cloud orchestration platform built with a highly modular, plugin-based architecture demonstrating advanced Django patterns and enterprise-level design principles.

Settings Configuration

  • Hierarchical Settings: base_settings.py (core) → settings.py (local) → specialized settings
  • Extension System: Automatic discovery and registration of plugins via WaldurExtension
  • Multi-database: PostgreSQL primary with optional read replicas
  • REST Framework: Custom authentication (Token, SAML2, OIDC, OAuth)
  • Celery Integration: Distributed task processing with priority queues

Django Apps Organization

Core Layer (waldur_core/)

  • core: Foundation with extension system, base models, authentication
  • structure: Organizational hierarchy (customers → projects → resources)
  • users: User management with profiles
  • permissions: Role-based access control with hierarchical scoping
  • quotas: Resource quota management
  • logging: Event logging and audit trail

Business Logic Layer (waldur_mastermind/)

  • marketplace: Central service catalog and provisioning (assembly app)
  • billing: Financial management and invoicing
  • support: Integrated support ticket system
  • analytics: Usage analytics and reporting

Provider Integration Layer

  • Cloud Providers: OpenStack, AWS, Azure, VMware, DigitalOcean
  • Compute Platforms: Rancher, SLURM, Kubernetes
  • Authentication: SAML2, Social/OAuth, Valimo

URL Routing and API Structure

  • Base Path: All REST endpoints under /api/
  • Router System: SortedDefaultRouter + NestedSimpleRouter for hierarchical resources
  • Naming Convention: Hyphenated resource names, UUID-based lookup
  • Extension Registration: Automatic URL discovery through plugin system

Models, Serializers, and Views Architecture

Model Architecture

  • Mixin-based Design: UuidMixin, StateMixin, LoggableMixin for code reuse
  • Hierarchical Structure: Customer → Project → Resource relationships
  • State Management: FSM-based transitions with django-fsm
  • Soft Deletion: Logical deletion for data retention

Serializer Patterns

  • AugmentedSerializerMixin: Dynamic field injection via signals
  • Permission Integration: Automatic queryset filtering
  • Eager Loading: Query optimization through eager_load() methods
  • Field Protection: Sensitive field protection during updates
  • Related Fields: ALWAYS use SlugRelatedField with slug_field="uuid" instead of PrimaryKeyRelatedField

ViewSet Architecture

  • ActionsViewSet: Base class with action-specific serializers
  • ExecutorMixin: Asynchronous resource operations
  • Permission Integration: Automatic permission checking
  • Atomic Transactions: Configurable transaction support

Authentication and Permissions

  • Multi-modal Auth: Token, Session, OIDC, SAML2 support
  • Impersonation: Staff user impersonation with audit trail
  • RBAC System: Hierarchical role-based access control
  • Scope-based Permissions: Customer/Project/Resource level permissions
  • Time-based Roles: Role assignments with expiration

Signal Handlers

  • Organization: Place signal handlers in dedicated handlers.py files, not in models.py
  • Registration: Register signals in apps.py ready() method with proper dispatch_uid

Task Queue and Background Processing

  • Celery Queues: tasks, heavy, background with priority routing
  • Beat Scheduler: Scheduled task system (24+ tasks)
  • Event Context: Thread-local context passing to background tasks
  • Extension Tasks: Automatic task registration from plugins

Key Design Patterns

  • Plugin Architecture: WaldurExtension base class for extensibility
  • Assembly Pattern: Marketplace loaded last as it depends on others
  • Factory Pattern: Extensions create Django apps dynamically
  • Observer Pattern: Extensive use of Django signals
  • State Machine: FSM-based resource state management
  • Mixin Pattern: Code reuse through multiple inheritance

Architecture Strengths

  1. Modularity: Clean separation of concerns with extension system
  2. Scalability: Multi-tenant architecture with horizontal scaling
  3. Extensibility: Plugin system for easy provider addition
  4. Security: Authentication and authorization layers
  5. Auditability: Complete event logging and audit trail
  6. Maintainability: Consistent patterns and well-structured code
  7. Performance: Optimized queries and caching strategies

Waldur Code Style Guide

Import Organization

  • Standards: Use isort with sections: future, standard-library, first-party, third-party, local-folder
  • Placement: ALWAYS place all imports at the top of the module
  • Inline Imports: NEVER use inline imports within functions or methods (except for dynamic imports when absolutely necessary)

Formatting

  • Formatter: Follow ruff formatting rules
  • Line Length: Line length restrictions are ignored (E501)
  • Indentation: Use 4 spaces, never tabs

Type Hints

  • Version: Python 3.10+ compatibility
  • Usage: Use type hints where possible
  • Modern Syntax: Use dict[str, str] instead of Dict[str, str]

Naming Conventions

  • Functions/Variables: Use snake_case
  • Classes: Use CamelCase
  • Constants: Use UPPER_SNAKE_CASE
  • Django Models: Follow Django conventions
  • Private: Prefix with underscore for internal use

Error Handling

  • Core Exceptions: Use exceptions from waldur_core.core.exceptions
  • Logging: Add appropriate logging for errors
  • Context: Include debugging context in error messages
  • Re-raising: Preserve original traceback when re-raising

Documentation

  • Docstrings: Required for public methods and classes
  • Comments: Avoid unnecessary comments - code should be self-documenting
  • TODO: Use # TODO: format with description and owner

Testing

  • Unit Tests: For complex functions
  • API Tests: For all endpoints
  • Directory Structure: Follow existing test directory structure
  • Naming: Test files should match module names with test_ prefix

Serializers

  • REST Conventions: Follow Django REST Framework patterns
  • Relationships: Use HyperlinkedRelatedField for relationships
  • Query Optimization: Implement eager_load() methods
  • UUID Fields: ALWAYS use SlugRelatedField(slug_field="uuid") instead of PrimaryKeyRelatedField

API Schema

  • Type Annotations: Use modern syntax (e.g., dict[str, str])
  • Response Documentation: Avoid verbose dictionary literals
  • Simple Actions: Omit unnecessary responses={status.HTTP_200_OK: None}
  • OpenAPI: Use @extend_schema decorators appropriately

Markdown Documentation

  • Linting: ALL markdown must pass mdl --style markdownlint-style.rb <path>
  • List Indentation: Use exactly 2 spaces for nested items
  • Consistency: Maintain consistent formatting throughout

API Design Consistency

  • Default Parameters: Choose defaults that match most common use case
  • Error Hierarchy:
  • Configuration errors (AttributeError) for invalid code/setup
  • Permission errors (PermissionDenied) for access control
  • Validation errors for user input
  • Function Signatures: Document parameter behavior clearly, especially optional parameters

Important Guidelines

  • No Emojis: Avoid emojis unless explicitly requested
  • Avoid "Comprehensive": Don't use this word in documentation
  • Incremental Changes: Make small, testable changes
  • Existing Patterns: Follow established project patterns

Waldur Permission System Guide

Permission Factory Usage

ALWAYS use permission_factory instead of manual has_permission checks in ViewSets.

For ViewSet Actions

1
2
3
4
5
6
7
8
9
# Define permissions as class attributes
compliance_overview_permissions = [
    permission_factory(PermissionEnum.UPDATE_CALL)
]

@action(detail=True, methods=["get"])
def compliance_overview(self, request, uuid=None):
    # No manual permission check needed - handled by permission_factory
    pass

Permission Factory Patterns

  • Current Object: permission_factory(PermissionEnum.PERMISSION_NAME) - no path needed
  • Related Object: permission_factory(PermissionEnum.PERMISSION_NAME, ["customer"]) - for related objects
  • Nested Path: permission_factory(PermissionEnum.PERMISSION_NAME, ["project.customer"]) - for nested relationships

For perform_create/perform_destroy Methods

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Use declarative permission attributes instead of manual perform_* overrides
def check_create_permissions(request, view, obj=None):
    """Check permissions for creating reviews."""
    serializer = view.get_serializer(data=request.data)
    serializer.is_valid(raise_exception=True)
    proposal = serializer.validated_data["proposal"]

    if not has_permission(
        request.user,
        PermissionEnum.MANAGE_PROPOSAL_REVIEW,
        proposal.round.call,
    ):
        raise exceptions.PermissionDenied()

def check_destroy_permissions(request, view, obj=None):
    """Check permissions for destroying reviews."""
    if obj and not has_permission(
        request.user,
        PermissionEnum.MANAGE_PROPOSAL_REVIEW,
        obj.proposal.round.call,
    ):
        raise exceptions.PermissionDenied()

create_permissions = [check_create_permissions]
destroy_permissions = [check_destroy_permissions]

When to Use Manual Checks

  • Complex permission logic that doesn't map to standard object relationships
  • Custom validation that requires dynamic permission targets
  • Legacy code not yet refactored to declarative patterns

Permission System Behavior

Expiration Handling

  • Basic permission queries (get_users_with_permission, get_scope_ids) include all roles regardless of expiration
  • Expiration checking is explicit via has_user(expiration_time=False), not implicit in has_permission()
  • Use has_user(expiration_time=current_time) for time-based validation

Error Handling

  • permission_factory doesn't catch AttributeError and convert to PermissionDenied
  • Test for actual exceptions the system raises, not ideal ones
  • Handle AttributeError when accessing missing nested attributes

Data Accuracy Critical Areas

  • User counting: Always use distinct() on user_id to avoid double-counting users with multiple roles
  • Permission checks: Handle edge cases (None scope, missing attributes) gracefully
  • Financial calculations: Never approximate - exact calculations required

Performance Optimization

Query Optimization Strategy

  • Use select_related() for foreign keys
  • Use prefetch_related() for reverse relationships
  • Use distinct() for deduplication instead of manual logic
  • Accept 20-30 queries for complex operations rather than approximations
  • Verify permission checks use reasonable query counts (≤3 for most operations)

Waldur Testing Guide

Test Writing Best Practices

1. Understand Actual System Behavior

  • Always verify actual behavior before writing tests - Don't assume how the system should work
  • Test what the system actually does, not what you think it should do
  • Example: Basic permission queries don't automatically filter expired roles

2. Use Existing Fixtures and Factories

  • Always use established fixtures - Don't invent your own role names
  • Use CustomerRole.SUPPORT not CustomerRole.MANAGER (which doesn't exist)
  • Use fixtures.ProjectFixture() for consistent test setup with proper relationships
  • Use factories.UserFactory() for creating test users with proper defaults

3. Error Handling Reality Check

  • Test for actual exceptions, not ideal ones
  • If the system raises AttributeError for missing attributes, test for AttributeError
  • Only test for PermissionDenied when the system actually catches and converts errors

4. Mock Objects for Complex Testing

  • Use Mock objects effectively for nested permission paths
  • Create realistic mock structures: mock_resource.project.customer = self.customer
  • Test permission factory with multiple source paths: ["direct_customer", "project.customer"]
  • Mock objects help test complex scenarios without database overhead

5. Time-Based Testing Patterns

  • Understand explicit vs implicit time checking
  • Basic has_permission() doesn't check expiration times automatically
  • Test boundary conditions: exact expiration time, microseconds past expiration
  • Create roles with timezone.now() ± timedelta() for realistic time testing

6. Integration vs Unit Test Strategy

  • Use integration tests for workflows, unit tests for utilities
  • Test complete permission flows: role creation → permission assignment → permission checking
  • Use APITransactionTestCase for integration tests requiring database transactions
  • Use TestCase for simple unit tests of utility functions

7. Performance Testing Considerations

  • Include query optimization tests where appropriate
  • Use override_settings(DEBUG=True) to count database queries
  • Test with multiple users/roles to ensure performance doesn't degrade

8. System Role Protection

  • Test that system roles work correctly even when modified
  • System roles like CustomerRole.OWNER should maintain functionality
  • Test that role modifications don't break core functionality
  • Verify that predefined roles have expected permissions

9. Edge Case Testing

  • Test None values, missing attributes, and circular references
  • Handle AttributeError when accessing missing nested attributes
  • Test with inactive users, deleted roles, removed permissions
  • Verify behavior with complex nested object hierarchies

Test Guidelines

  • Test behavior, not implementation
  • One assertion per test when possible
  • Clear test names describing scenario
  • Use existing test utilities/helpers
  • Tests should be deterministic

Debugging Complex Systems

When fixing performance or accuracy issues:

  1. Isolate the problem:
  2. Run individual failing tests to understand specific issues
  3. Use pytest -v -s for verbose output with print statements

  4. Check if multiple tests fail for the same underlying reason

  5. Understand test expectations:

  6. Read test comments carefully - they often explain intended behavior
  7. Check if tests expect specific error types

  8. Look for conflicting expectations between test suites

  9. Fix systematically:

  10. Fix one root cause at a time
  11. After each fix, run full test suite to check for regressions

  12. Update related tests for consistency when changing behavior

  13. API changes require test updates:

  14. When changing function signatures or default parameters, expect test failures
  15. Update tests for consistency rather than reverting functional improvements
  16. Document parameter behavior changes clearly

Development guidelines

  1. Follow PEP8
  2. Use git flow
  3. Write docstrings

Flow for feature tasks

  • Create a new branch from develop
1
2
3
  git checkout develop
  git pull origin develop
  git checkout -b feature/task-id
  • Perform brilliant work (don't forget about tests!)
  • Verify that tests are passing.
  • Push all changes to origin (https://code.opennodecloud.com/)
  • Create a Merge Request and assign it to a reviewer. Make sure that MR can be merged automatically. If not, resolve the conflicts by merging develop branch into yours:
1
2
  git checkout feature/task-id
  git pull origin develop
  • Resolve ticket in JIRA.

Ended: Guides

API Integration Guide

This guide covers data loading patterns, API client usage, and refresh mechanisms for integrating with the Waldur MasterMind backend.

API Data Loading and Refresh Patterns

The application uses multiple approaches for loading data from REST APIs in forms and handling data refresh operations, showing evolution from legacy Redux patterns to modern React Query implementations.

Data Loading Patterns

React Query/TanStack Query (Modern Approach)

The preferred pattern for new components uses React Query for efficient data fetching:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
const {
  data: projects,
  isLoading,
  error,
  refetch: refetchProjects,
} = useQuery({
  queryKey: ['CustomerProjects', selectedCustomer?.uuid],
  queryFn: () => fetchCustomerProjects(selectedCustomer.uuid),
  staleTime: 5 * 60 * 1000, // 5 minutes
});

Key Features:

  • Automatic Caching: 5-minute stale time for most queries
  • Built-in Loading States: isLoading, error, data
  • Manual Refresh: refetch() function for explicit updates
  • Query Invalidation: Cache invalidation through query keys
  • Background Refetching: Automatic background updates

Custom Hook Pattern

Centralized data fetching logic wrapped in reusable hooks:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
export const useOrganizationGroups = () => {
  const user = useSelector(getUser);
  const query = useQuery({
    queryKey: ['organizationGroups'],
    queryFn: () => getAllPages((page) =>
      organizationGroupsList({ query: { page } })
    ).then(items => items.map(item => ({ ...item, value: item.url }))),
    staleTime: 5 * 60 * 1000,
  });

  const disabled = query.data?.length === 0 && !user.is_staff;
  const tooltip = disabled ? translate('Access policies cannot be configured...') : undefined;

  return { ...query, disabled, tooltip };
};

Benefits:

  • Business Logic Integration: Transforms data for UI consumption
  • Computed Properties: Adds disabled states and tooltips
  • Reusability: Shared across multiple components
  • Centralized Error Handling: Consistent error management

Redux/Redux Saga Pattern (Legacy)

Used primarily for table data management:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
function* fetchList(action) {
  const { table, extraFilter, pullInterval, force } = action.payload;

  try {
    const state = yield select(getTableState(table));
    const request = {
      currentPage: state.pagination.currentPage,
      pageSize: state.pagination.pageSize,
      filter: { ...extraFilter, field: fields },
    };

    const { rows, resultCount } = yield call(options.fetchData, request);
    yield put(actions.fetchListDone(table, entities, order, resultCount));
  } catch (error) {
    yield put(actions.fetchListError(table, error));
  }
}

Characteristics:

  • Centralized State: Redux store for table data
  • Automatic Pagination: Built-in pagination and filtering
  • Request Cancellation: AbortController support
  • Periodic Polling: Configurable refresh intervals

Data Refresh Mechanisms

CRUD Operations Refresh

Create Operations:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
const onSubmit = async (formData: ProjectFormData) => {
  try {
    const response = await projectsCreate({
      body: {
        name: formData.name,
        description: formData.description,
        customer: formData.customer.url,
      },
    });

    if (refetch) {
      await refetch(); // Refresh parent data
    }

    showSuccess(translate('Project has been created.'));
    closeDialog();
  } catch (e) {
    showErrorResponse(e, translate('Unable to create project.'));
  }
};

Edit Operations:

1
2
3
4
5
6
// Optimistic updates in Redux
yield put(actions.entityUpdate(table, entity));

// Manual refresh after edit
await updateResource(resourceData);
refetch(); // Refresh data

Delete Operations:

1
2
3
4
5
6
await marketplaceProviderOfferingsRemoveOfferingComponent({
  path: { uuid: offering.uuid },
  body: { uuid: component.uuid },
});
refetch(); // Refresh parent data
dispatch(showSuccess(translate('Component has been removed.')));

Refresh Strategies

Strategy Implementation Use Case
Explicit Refetch const { refetch } = useQuery(...); await refetch(); Manual refresh after CRUD operations
Table Refresh Button <TableRefreshButton onClick={() => props.fetch(true)} /> User-initiated refresh
Automatic Polling pullInterval in Redux saga Real-time data updates
Query Invalidation queryClient.invalidateQueries(['queryKey']) Cache invalidation

Error Handling and Loading States

Consistent Error Display

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{groupsLoading ? (
  <LoadingSpinner />
) : groupsError ? (
  <LoadingErred
    loadData={refetchGroups}
    message={translate('Unable to load organization groups.')}
  />
) : (
  <SelectField options={organizationGroups} />
)}

Global Error Handling

1
2
3
4
5
6
7
8
9
export const queryClient = new QueryClient({
  queryCache: new QueryCache({
    onError: (error: any) => {
      if (error?.response?.status == 404) {
        router.stateService.go('errorPage.notFound');
      }
    },
  }),
});

API Integration Patterns

Waldur JS Client Integration

Primary API client with typed endpoints:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import {
  projectsCreate,
  projectsList,
  customersList
} from 'waldur-js-client';

// Typed API calls with request/response types
const response = await projectsCreate({
  body: {
    name: formData.name,
    customer: formData.customer.url,
  },
});

Async Form Field Loading

Dynamic data loading for form fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<Field
  component={Select}
  name="customer"
  loadOptions={(query, prevOptions, page) =>
    organizationAutocomplete(query, prevOptions, page, {
      field: ['uuid', 'name', 'url'],
      o: 'name',
    })
  }
  getOptionLabel={(option) => option.name}
  getOptionValue={(option) => option.url}
/>

Caching Strategies

React Query Cache

  • Query-based caching: Uses query keys for cache management
  • Automatic background refetching: Keeps data fresh
  • Configurable stale time: Typically 5 minutes for most queries
  • Request deduplication: Prevents duplicate requests

Redux Store Cache

  • Table data cached: In Redux state for tables
  • Manual cache invalidation: Explicit cache clearing
  • Optimistic updates: Immediate UI updates for CRUD operations

Best Practices

  1. New Components: Use React Query with custom hooks
  2. Error Handling: Consistent use of LoadingErred component with retry functionality
  3. Caching: 5-minute stale time for most queries, longer for static data
  4. Refresh Strategy: Always call refetch() after successful CRUD operations
  5. Loading States: Use isLoading state for UI feedback
  6. API Integration: Prefer waldur-js-client over direct fetch calls
  7. Form Validation: Use async validation with API dependency checking

This data loading architecture demonstrates the application's evolution toward modern React patterns while maintaining backward compatibility with existing table infrastructure and Redux-based components.

Migration Patterns

The application shows clear migration from Redux to React Query:

Aspect Redux Pattern React Query Pattern
Data Loading Redux actions + sagas useQuery hooks
Caching Redux store Query cache
Error Handling Redux error actions Query error states
Loading States Redux loading flags isLoading state
Refresh Dispatch actions refetch() function
Polling Saga intervals Query refetch intervals

Architecture Guide

This guide covers the application architecture, design patterns, and organizational structure of Waldur HomePort.

Frontend Stack

  • React with TypeScript for component development
  • Vite for build tooling and development server
  • Redux with Redux Saga for legacy state management
  • UI Router React for navigation (state-based routing)
  • React Bootstrap (Bootstrap 5) for UI components
  • React Final Form for modern form handling
  • ECharts for data visualization
  • Leaflet with React Leaflet for mapping
  • TanStack React Query for server state management

Check Current Versions

Check all major dependencies

yarn list react typescript vite redux @uirouter/react react-bootstrap react-final-form echarts leaflet @tanstack/react-query

Check specific package version

yarn info version

Key Architectural Patterns

Module Organization

The codebase follows a feature-based folder structure under src/:

  • Each domain (customer, project, marketplace, etc.) has its own folder
  • Components are co-located with their specific business logic
  • Shared utilities are in core/ and table/
  • API interactions use Redux patterns with sagas

State Management

Modern Patterns (Use for New Development)

  • TanStack React Query: Server state management and caching for API calls
  • React Final Form: Local form state management
  • Local Component State: useState and useReducer for UI state
  • Custom Hooks: Reusable state logic and business operations

Legacy Patterns (Maintenance Only - Do Not Extend)

  • Redux Store: Global state with dynamic reducer injection (legacy - avoid for new features)
  • Redux Saga: Async operations and side effects (legacy - use React Query instead)
  • Table Store: Specialized table data management in src/table/ (legacy pattern)

Navigation & Routing

  • Uses UI-Router for React with state-based routing
  • Routes defined in module-specific routes.ts files
  • Navigation context provides tab and breadcrumb management

Data Fetching

Modern Approach (Use for New Development)

  • TanStack React Query: Preferred for server state management and caching
  • Custom Hooks: Reusable data fetching logic with React Query
  • Waldur JS Client: TypeScript API client integration
  • Automatic Caching: 5-minute stale time with background refetching

Legacy Approach (Maintenance Only)

  • Redux Actions/Sagas: Centralized API calls (legacy - use React Query instead)
  • Table Store: Standardized data loading patterns (legacy pattern)
  • Periodic Polling: Real-time updates through sagas (use React Query polling instead)

Component Architecture

  • Container Components: Handle data fetching and state management
  • Presentation Components: Pure UI components with props
  • Form Components: Specialized forms using React Final Form
  • Table Components: Reusable table infrastructure with filtering, sorting, pagination

Key Directories

  • src/core/ - Shared utilities, API clients, and base components
  • src/table/ - Reusable table components and data management
  • src/form/ - Form components and field implementations
  • src/marketplace/ - Service marketplace and offering management (largest module)
  • src/customer/ - Organization management and billing
  • src/project/ - Project management and resources
  • src/auth/ - Authentication and identity provider integration
  • src/administration/ - Admin panel functionality
  • src/azure/ - Azure cloud integration
  • src/booking/ - Resource booking system
  • src/broadcasts/ - System announcements
  • src/dashboard/ - Dashboard components
  • src/navigation/ - Navigation and layout components
  • src/proposals/ - Proposal management
  • src/quotas/ - Resource quotas management
  • src/theme/ - Theme management (dark/light mode)
  • src/user/ - User management
  • src/metronic/ - UI framework integration

Backend Integration

Integrates with Waldur MasterMind REST API requiring CORS configuration on the backend for local development.

API Client

  • Waldur JS Client - Custom API client for Waldur MasterMind
  • Auto-generated client with TypeScript support
  • Request/response interceptors for authentication and error handling
  • Token-based authentication with auto-refresh capabilities

Version Management

Check current version

grep "waldur-js-client" package.json

Check latest available version

yarn info waldur-js-client version

Update to latest version in package.json, then install

yarn install

Build System & Performance

Modern Build Configuration

  • Vite 7.0 with ES modules support
  • Node.js v23.7.0 (latest LTS) compatibility
  • Code splitting with lazy loading for all major features
  • Optimized bundle sizes and asset processing
  • Source maps for development and production debugging

Performance Optimizations

  • Lazy component loading with lazyComponent utility
  • Dynamic reducer injection for Redux store
  • Automatic code splitting by route and feature
  • Optimized asset loading (images, fonts, SVG)
  • Bundle analysis and optimization tools

Asset Management

  • SVG files processed through SVGR 8.1.0 plugin for React components
  • Images and static assets in src/images/
  • Font files managed through Vite's asset pipeline
  • Markdown content processed through vite-plugin-markdown
  • Monaco Editor 0.52.2 for code editing capabilities
  • Sass 1.85.0 for SCSS preprocessing

Environment Variables

Project Overview

Waldur HomePort is a React-based web frontend for the Waldur MasterMind cloud orchestrator. It's a TypeScript application built with Vite that provides a comprehensive management interface for cloud resources, organizations, projects, and marketplace offerings.

Code Quality Standards

This guide covers code quality standards, testing practices, and technical requirements for Waldur HomePort.

Technical Standards

Architecture Principles

  • Composition over inheritance - Use dependency injection
  • Interfaces over singletons - Enable testing and flexibility
  • Explicit over implicit - Clear data flow and dependencies
  • Test-driven when possible - Never disable tests, fix them

Code Quality Requirements

  • Every commit must:
  • Compile successfully
  • Pass all existing tests
  • Include tests for new functionality

  • Follow project formatting/linting

  • Before committing:

  • Run formatters/linters
  • Self-review changes
  • Ensure commit message explains "why"

Error Handling

  • Fail fast with descriptive messages
  • Include context for debugging
  • Handle errors at appropriate level
  • Never silently swallow exceptions

Testing Strategy

Testing Frameworks

  • Unit Tests: Vitest with React Testing Library for component testing
  • Integration Tests: Cypress for end-to-end workflows

Check Testing Framework Versions

Check current versions

yarn info vitest @testing-library/react cypress version```

  • Test files use .test.ts/.test.tsx extensions
  • Setup files in test/setupTests.js
  • Integrated coverage reporting

Test Guidelines

  • Test behavior, not implementation
  • One assertion per test when possible
  • Clear test names describing scenario
  • Use existing test utilities/helpers
  • Tests should be deterministic

Test Code Sharing & Mocking

Extracting Common Test Code:

  • Extract shared test data into separate files (e.g., test-utils.ts)
  • Only mock what's actually imported by the component under test
  • Don't mock exports that aren't used - it adds unnecessary complexity
  • Verify import paths match actual usage (e.g., ./constants vs @waldur/marketplace/common/constants)

Vitest Mocking Constraints:

  • vi.mock() calls must be at the top level, not inside functions
  • Vitest hoists mocks, so they can't reference variables defined later
  • Share test data as exported constants, not function calls
  • Mock the exact module path used in the component's imports

Example Pattern:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// test-utils.ts
export const mockOffering = { uuid: '123', name: 'Test' };
export const mockPlan = { uuid: '456', name: 'Plan' };

// component.test.tsx
import { mockOffering, mockPlan } from './test-utils';

vi.mock('./constants', () => ({
  getBillingPeriods: () => [...], // Only mock what's actually used
  // Don't include ADD_PLAN_FORM_ID if component doesn't import it
}));

Code Duplication Detection:

  • CI/CD uses jscpd with strict thresholds (typically 250 tokens)
  • Extract common patterns properly - don't game the detector with formatting
  • Shared test utilities reduce duplication and improve maintainability

Development Guidelines

TypeScript Configuration

  • Uses @waldur/* path mapping for internal imports
  • Strict TypeScript checking disabled for legacy compatibility
  • Module resolution set to "Bundler" for Vite compatibility

Code Style

  • ESLint with flat config format enforced with TypeScript, React, and accessibility rules
  • Prettier for code formatting (2 spaces, semicolons, single quotes)
  • Import ordering enforced with @waldur imports grouped separately
  • SCSS/CSS linting with Stylelint
  • Husky for git hooks and pre-commit checks

Check Code Style Tool Versions

``` Check current versions

yarn info eslint prettier stylelint husky version```

TypeScript and SDK Types

  • Always prefer SDK types over custom types from waldur-js-client package
  • Import types using type keyword: import { type ComponentUsageCreateRequest } from 'waldur-js-client'
  • Common SDK types to use instead of custom interfaces:
  • ResourcePlanPeriod - for plan periods with components
  • BaseComponentUsage - for component usage data in periods
  • ComponentUsageCreateRequest - for usage submission request bodies
  • ComponentUserUsageCreateRequest - for user usage submission request bodies
  • ComponentUsage - for general component usage data
  • All marketplace API request/response types are available in the SDK
  • When using React Final Form, use standard pattern: <Field component={NumberField as any} />
  • Convert between SDK string types and numbers when necessary (e.g., parseFloat(component.usage))
  • Handle nullable SDK types properly with optional chaining (period.value?.components)

Tooling

Essential Commands

Code Quality

  • yarn lint:check - Run ESLint checks
  • yarn lint:fix - Fix ESLint issues automatically
  • yarn format:check - Check code formatting with Prettier
  • yarn format:fix - Auto-format code with Prettier
  • yarn style:check - Check SCSS/CSS styles with Stylelint
  • yarn deps:unused - Check for unused dependencies with Knip
  • yarn tsc - Typescript type check

Testing

  • yarn test - Run unit tests with Vitest
  • yarn ci:test - Run full integration test suite with Cypress
  • yarn ci:run - Run Cypress tests headless

Dependency Management

  • yarn deps:unused - Find unused dependencies and exports with Knip
  • yarn deps:circular - Check for circular dependencies with Madge

Tooling Standards

  • Use project's existing build system
  • Use project's test framework
  • Use project's formatter/linter settings
  • Don't introduce new tools without strong justification

Quality Assurance

Code Quality & Analysis

  • Knip for unused dependency detection
  • Madge for circular dependency analysis
  • Lint-staged for pre-commit code formatting
  • PostCSS with autoprefixer and cssnano for CSS optimization

Modern Development Practices

  • ESM (ES Modules) throughout the codebase
  • TypeScript with comprehensive typing
  • Flat ESLint config format
  • Husky git hooks for automated quality checks
  • Yarn package management with lockfile integrity

Component Library Guide

This guide covers the comprehensive set of reusable UI components and specialized patterns used throughout Waldur HomePort.

Common UI Widgets and Reusable Components

The application features a comprehensive set of reusable UI components organized by category:

Tables and Data Display

Component Location Description Key Features
Table src/table/Table.tsx Main table component Filtering, sorting, pagination, column visibility, export
ActionButton src/table/ActionButton.tsx Reusable action button Tooltip, loading state, multiple variants
ActionsDropdown src/table/ActionsDropdown.tsx Dropdown for table actions Bulk operations, contextual actions
ExpandableContainer src/table/ExpandableContainer.tsx Collapsible row details Table row expansion, detail views
TablePagination src/table/TablePagination.tsx Pagination controls Page navigation, size selection

Forms and Input Components

Component Location Description Key Features
WizardForm src/form/WizardForm.tsx Multi-step form wizard Step navigation, validation, progress indicator
VStepperFormStepCard src/form/VStepperFormStep.tsx Card-based form step Loading state, disabled state with tooltip
AwesomeCheckbox src/core/AwesomeCheckbox.tsx Enhanced checkbox Switch-style, tooltip support
SelectField src/form/SelectField.tsx Dropdown selection Options, search, validation
StringField src/form/StringField.tsx Text input field Validation, placeholder, help text
NumberField src/form/NumberField.tsx Numeric input Min/max validation, step control
DateField src/form/DateField.tsx Date picker Date selection, validation
FileUploadField src/form/FileUploadField.tsx File upload Drag & drop, validation
MarkdownEditor src/form/MarkdownEditor.tsx Markdown editor Preview, syntax highlighting
SecretField src/form/SecretField.tsx Password/secret input Show/hide toggle, validation
SubmitButton src/form/SubmitButton.tsx Submit button Loading state, disabled state

Modal and Dialog Components

Component Location Description Key Features
ModalDialog src/modal/ModalDialog.tsx Base modal component Header, body, footer, icon support
ConfirmationDialog src/modal/ConfirmationDialog.tsx Confirmation modal Destructive actions, custom text
ActionDialog src/modal/ActionDialog.tsx Generic action dialog Form support, validation

Navigation Components

Component Location Description Key Features
TabsList src/navigation/TabsList.tsx Tab navigation Nested dropdowns, active detection
Layout src/navigation/Layout.tsx Application layout Responsive, sidebar, header
Breadcrumbs src/navigation/header/breadcrumb/Breadcrumbs.tsx Navigation breadcrumbs Hierarchical navigation

Cards and Layout Components

Component Location Description Key Features
Panel src/core/Panel.tsx Basic card panel Header, actions, flexible content
AccordionCard src/core/AccordionCard.tsx Collapsible card Toggle functionality, custom styling
WidgetCard src/dashboard/WidgetCard.tsx Dashboard widget Flexible layout, action dropdown
StatisticsCard src/core/StatisticsCard.tsx Statistics display Large value display, "View all" link

Data Display Components

Component Location Description Key Features
Badge src/core/Badge.tsx Status indicator Multiple variants, icon support, tooltip
StateIndicator src/core/StateIndicator.tsx Status with animation Loading animation, color variants
BooleanBadge src/core/BooleanBadge.tsx Boolean indicator Yes/No display, true/false states
TruncatedText src/core/TruncatedText.tsx Responsive text Automatic truncation, expandable
TruncatedDescription src/core/TruncatedDescription.tsx Description text Read more/less functionality
ImagePlaceholder src/core/ImagePlaceholder.tsx Image fallback Automatic sizing, circular option
Avatar src/core/Avatar.tsx User avatar Profile pictures, initials fallback

Loading and State Components

Component Location Description Key Features
LoadingSpinner src/core/LoadingSpinner.tsx Loading indicator Consistent styling, size variants
LoadingErred src/core/LoadingErred.tsx Error state display Error handling, retry actions

Chart and Visualization

Component Location Description Key Features
EChart src/core/EChart.tsx Apache ECharts wrapper Theme support, export functionality
EChartActions src/core/EChartActions.tsx Chart actions Export buttons, chart controls

Utility Components

Component Location Description Key Features
CopyToClipboard src/core/CopyToClipboard.tsx Copy functionality Click to copy, success feedback
CopyToClipboardButton src/core/CopyToClipboardButton.tsx Copy button Icon button, tooltip
Tooltip src/core/Tooltip.tsx Tooltip wrapper Help text, positioning
ProgressSteps src/core/ProgressSteps.tsx Step indicator Multi-step processes, progress

Component Design Principles

  • TypeScript interfaces for comprehensive type safety
  • Consistent styling using React Bootstrap and custom classes
  • Accessibility features with proper ARIA attributes
  • Responsive design with mobile-first approach
  • Theme support with light/dark mode compatibility
  • Loading states with integrated spinner functionality
  • Error handling with proper error boundaries
  • Internationalization with translate function usage

These components provide a comprehensive foundation for building consistent, accessible, and maintainable UI throughout the Waldur HomePort application.

BaseDeployPage Component Pattern

The BaseDeployPage component (located at src/marketplace/deploy/DeployPage.tsx) serves as the central foundation for all marketplace offering deployment/ordering flows. It provides a standardized, multi-step form interface that can be configured for different types of cloud resources and services.

Architecture and Purpose

BaseDeployPage handles:

  • Step Management: Progressive form steps with validation and completion tracking
  • State Management: Integration with Redux for form state and user selections
  • Form Validation: Real-time validation and error display
  • Layout Management: Sidebar layout with progress tracking
  • API Integration: Order submission and error handling
  • Context-Aware Initialization: Auto-populates organization/project based on context

Key Configuration Interface

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
interface DeployPageProps {
  offering: Offering;
  limits?: string[];
  updateMode?: boolean;
  previewMode?: boolean;
  order?: OrderResponse;
  plan?: Plan;
  initialLimits?: AttributesType;
  inputFormSteps: OfferingConfigurationFormStep[]; // Main configuration
}

Step Definition Structure

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
interface VStepperFormStep<T = VStepperFormStepProps> {
  label: string;                    // Display name
  id: string;                      // Unique identifier
  component: React.ComponentType<T>; // React component to render
  params?: Record<string, any>;    // Additional configuration
  fields?: Array<string>;          // Form fields managed by this step
  required?: boolean;              // Whether step is mandatory
  requiredFields?: Array<string>;  // Fields that must be completed
  isActive?: (data?: any) => boolean; // Dynamic step visibility
}

Usage Example: OpenstackInstanceOrder

1
2
3
4
// src/openstack/openstack-instance/OpenstackInstanceOrder.tsx
export const OpenstackInstanceOrder = (props) => (
  <BaseDeployPage inputFormSteps={deployOfferingSteps} {...props} />
);

Step Configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// src/openstack/openstack-instance/deploy/steps.ts
export const deployOfferingSteps: OfferingConfigurationFormStep[] = [
  DetailsOverviewStep,           // Organization/Project selection
  FormCloudStep,                 // Cloud region (if shared offering)
  FormImageStep,                 // VM image selection
  FormHardwareConfigurationStep, // Flavor, storage configuration
  FormNetworkSecurityStep,       // Network and security groups
  FormStartupScriptStep,         // Automation/user data
  FormFinalConfigurationStep,    // Name, description
];

Common Implementation Pattern

All offering types follow the same pattern:

  1. Define Steps: Create array of OfferingConfigurationFormStep objects
  2. Wrap BaseDeployPage: Pass steps as inputFormSteps prop
  3. Register in Marketplace: Register in src/marketplace/common/registry.ts

Other Examples:

  • OpenstackVolumeOrder - Volume deployment
  • OpenstackTenantOrder - Tenant creation
  • RancherOrderForm - Rancher cluster deployment
  • RequestOrderForm - Support requests

Key Features

Dynamic Step Filtering

1
2
3
4
5
6
7
const formSteps = useMemo(
  () =>
    inputFormSteps.filter(
      (step) => (step.isActive && step.isActive(selectedOffering)) ?? true,
    ),
  [selectedOffering],
);

Progressive Validation

  • Tracks completed steps based on required field validation
  • Uses scroll position to mark optional steps as "seen"
  • Real-time validation feedback with error display

Multiple Operation Modes

  • Create Mode: New resource deployment
  • Update Mode: Editing existing orders with pre-populated values
  • Preview Mode: Read-only display of form steps

Integration with Marketplace System

Registry Configuration

1
2
3
4
5
6
7
8
export const OpenStackInstanceOffering: OfferingConfiguration = {
  type: INSTANCE_TYPE,
  orderFormComponent: OpenstackInstanceOrder,
  detailsComponent: OpenstackInstanceDetails,
  checkoutSummaryComponent: CheckoutSummary,
  serializer: instanceSerializer,
  // ... other configuration
};

Sidebar Integration

The DeployPageSidebar provides:

  • Progress tracking with step completion status
  • Error display for validation issues
  • Checkout summary with pricing information
  • Order summary customizable per offering type

Best Practices

  1. Consistent Step Structure: All offering types use the same step interface
  2. Lazy Loading: Components are lazy-loaded for better performance
  3. Type Safety: Strong TypeScript typing throughout
  4. Reusable Components: Common steps like DetailsOverviewStep are shared
  5. Error Handling: Comprehensive validation and error display
  6. Accessibility: Proper ARIA labels and keyboard navigation

The BaseDeployPage component represents a well-architected, reusable foundation that allows different cloud services to implement their specific deployment workflows while maintaining consistency across the marketplace experience.

Type-Specific Fields in Redux Forms

The application uses a sophisticated type-based field selection system for creating dynamic Redux forms, exemplified by the SupportSettingsForm.tsx component.

Core Pattern: Dynamic Field Selection

The primary pattern uses a FieldRow component that selects appropriate field types based on configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
const FieldRow = ({ field, ...rest }) =>
  field.type === 'string' ? (
    <StringField {...rest} />
  ) : field.type === 'boolean' ? (
    <AwesomeCheckboxField
      label={getKeyTitle(field.key)}
      hideLabel
      className="mt-3"
      {...rest}
    />
  ) : field.type === 'email_field' ? (
    <EmailField {...rest} />
  ) : field.type === 'text_field' ? (
    <TextField {...rest} />
  ) : field.type === 'integer' ? (
    <NumberField {...rest} />
  ) : field.type === 'secret_field' ? (
    <SecretField {...rest} />
  ) : (
    <StringField {...rest} />
  );

Field Type System

The application supports these field types:

  • string - Basic text input using StringField
  • boolean - Checkbox using AwesomeCheckboxField
  • email_field - Email input with validation using EmailField
  • text_field - Multi-line text using TextField
  • integer - Numeric input using NumberField
  • secret_field - Password/secret input using SecretField

Redux Form Integration

All fields are wrapped with Redux Form's Field component and FormGroup:

1
2
3
4
5
6
7
8
<Field
  component={FormGroup}
  name={field.key}
  key={field.key}
  label={field.description}
>
  <FieldRow field={field} />
</Field>

Base FormField Interface

All field components extend the FormField interface for consistent props:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
export interface FormField {
  name?: string;
  input?: WrappedFieldInputProps;
  meta?: WrappedFieldMetaProps;
  required?: boolean;
  label?: ReactNode;
  description?: ReactNode;
  tooltip?: ReactNode;
  validate?: Validator | Validator[];
  disabled?: boolean;
  hideLabel?: boolean;
  normalize?: Normalizer;
  format?: Formatter | null;
  parse?: Parser;
  noUpdateOnBlur?: boolean;
  onBlur?(e): void;
  containerClassName?: string;
  spaceless?: boolean;
  readOnly?: boolean;
}

Configuration-Driven Forms

Forms are generated from configuration objects:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
export const SupportSettingsForm = ({ name }) => {
  const fields = SettingsDescription.find((group) =>
    group.description.toLowerCase().includes(name),
  ).items;

  return (
    <>
      {fields.map((field) => (
        <Field
          component={FormGroup}
          name={field.key}
          key={field.key}
          label={field.description}
        >
          <FieldRow field={field} />
        </Field>
      ))}
    </>
  );
};

Field Configuration Structure

1
2
3
4
5
6
{
  key: 'FIELD_NAME',
  description: 'Field description',
  default: 'default_value',
  type: 'string' | 'boolean' | 'integer' | 'email_field' | 'text_field' | 'secret_field'
}

Advanced Field Factory Pattern

For more complex scenarios, the system uses a comprehensive field factory:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const getFieldComponent = useCallback((field, index, { key, ...props }) => {
  if (field.component) {
    return <field.component key={key} {...props} {...(field.extraProps || {})} />;
  } else if (field.type === 'string') {
    return <StringField key={key} {...props} validate={field.validate} />;
  } else if (field.type === 'json') {
    return <MonacoField key={key} {...props} language="json" validate={validateJSON} />;
  } else if (field.type === 'datetime') {
    return <DateTimeField key={key} {...props} />;
  } else if (field.type === 'select') {
    return <SelectField key={key} {...props} options={field.options} />;
  } else if (field.type === 'async_select') {
    return <AsyncSelectField key={key} {...props} {...field.extraProps} />;
  }
  // ... other field types
}, []);

Validation and Error Handling

The system provides comprehensive validation through:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
// Core validators
export const required = (value) =>
  value || value === 0 ? undefined : translate('This field is required.');

export const email = (value) =>
  value && !/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i.test(value)
    ? translate('Invalid email address')
    : undefined;

// Validator composition
export const composeValidators = (...validators) => (value) =>
  validators.reduce((error, validator) => error || validator(value), undefined);

Best Practices for Type-Safe Forms

  1. Consistent Type Strings: Use standardized type identifiers across field configurations
  2. Fallback Strategy: Always provide a default field type (typically StringField)
  3. Props Interface: Extend the base FormField interface for type safety
  4. Validator Composition: Use composeValidators for complex validation logic
  5. Error Handling: Integrate with Redux Form's meta.touched state for error display
  6. Configuration-Driven: Use data structures to define forms rather than hardcoding

This type-specific field system enables dynamic form generation while maintaining type safety and consistent user experience across the application.

Development Setup Guide

This guide covers development environment setup, build configuration, and essential commands for Waldur HomePort development.

Essential Commands

Development

  • yarn start - Start development server (runs on port 8001)
  • yarn devcontainer - Start dev server for containerized development (binds to 0.0.0.0:8001)
  • yarn build - Create production build
  • yarn preview - Preview production build

Code Quality

  • yarn lint:check - Run ESLint checks
  • yarn lint:fix - Fix ESLint issues automatically
  • yarn format:check - Check code formatting with Prettier
  • yarn format:fix - Auto-format code with Prettier
  • yarn style:check - Check SCSS/CSS styles with Stylelint
  • yarn deps:unused - Check for unused dependencies with Knip
  • yarn tsc - Typescript type check

Testing

  • yarn test - Run unit tests with Vitest
  • yarn ci:test - Run full integration test suite with Cypress
  • yarn ci:run - Run Cypress tests headless

Dependency Management

  • yarn deps:unused - Find unused dependencies and exports with Knip
  • yarn deps:circular - Check for circular dependencies with Madge

Version Management

Check current dependency versions

yarn list --depth=0

Check for outdated packages

yarn outdated

Check specific package version

yarn info <package-name> version

After updating version in package.json, install dependencies

yarn install

Update all dependencies to latest versions (use with caution)

yarn upgrade

Build System & Performance

Modern Build Configuration

  • Vite with ES modules support
  • Node.js (latest LTS) compatibility
  • Code splitting with lazy loading for all major features
  • Optimized bundle sizes and asset processing
  • Source maps for development and production debugging

Check Build Tool Versions

node --version yarn --version yarn info vite version

Performance Optimizations

  • Lazy component loading with lazyComponent utility
  • Dynamic reducer injection for Redux store
  • Automatic code splitting by route and feature
  • Optimized asset loading (images, fonts, SVG)
  • Bundle analysis and optimization tools

Key Development Tools

Code Quality & Analysis

  • Knip for unused dependency detection
  • Madge for circular dependency analysis
  • Lint-staged for pre-commit code formatting
  • PostCSS with autoprefixer and cssnano for CSS optimization

Modern Development Practices

  • ESM (ES Modules) throughout the codebase
  • TypeScript with comprehensive typing
  • Flat ESLint config format
  • Husky git hooks for automated quality checks
  • Yarn package management with lockfile integrity

Check Development Tool Versions

yarn info typescript eslint prettier husky version

Asset Management

  • SVG files processed through SVGR plugin for React components
  • Images and static assets in src/images/
  • Font files managed through Vite's asset pipeline
  • Markdown content processed through vite-plugin-markdown
  • Monaco Editor for code editing capabilities
  • Sass for SCSS preprocessing

Check Asset Processing Tool Versions

Check current versions

yarn info @svgr/rollup-plugin vite-plugin-markdown monaco-editor sass version

Environment Variables

Backend Integration

Integrates with Waldur MasterMind REST API requiring CORS configuration on the backend for local development.

API Client

  • Waldur JS Client - Custom API client for Waldur MasterMind
  • Auto-generated client with TypeScript support
  • Request/response interceptors for authentication and error handling
  • Token-based authentication with auto-refresh capabilities

Version Management

Check current version

grep "waldur-js-client" package.json

Check latest available version

yarn info waldur-js-client version

Update to latest version in package.json, then install

yarn install

Development Environment Setup

Prerequisites

  • Node.js (latest LTS - check with node --version)
  • Yarn package manager (check with yarn --version)
  • Backend Waldur MasterMind API running (typically on port 8000)

Check Prerequisites

Verify Node.js version (should be latest LTS)

node --version

Verify Yarn installation

yarn --version

Check if backend API is running

curl -I <http://localhost:8000/api/>

Initial Setup

  1. Install dependencies: yarn install
  2. Configure environment variables in .env file
  3. Start development server: yarn start
  4. Access application at <http://localhost:8001>

Docker Development

For containerized development:

  1. Use yarn devcontainer to start server bound to 1.1.1.0:8001
  2. Ensure proper network configuration for container access

IDE Configuration

  • TypeScript support with path mapping for @waldur/* imports
  • ESLint and Prettier integration for code formatting
  • Vitest integration for test running and debugging

Development Workflow

This guide covers the development process, planning strategies, and workflow best practices for Waldur HomePort.

Philosophy

Core Beliefs

  • Incremental progress over big bangs - Small changes that compile and pass tests
  • Learning from existing code - Study and plan before implementing
  • Pragmatic over dogmatic - Adapt to project reality
  • Clear intent over clever code - Be boring and obvious

Simplicity Means

  • Single responsibility per function/class
  • Avoid premature abstractions
  • No clever tricks - choose the boring solution
  • If you need to explain it, it's too complex

Process

1. Planning & Staging

Break complex work into 3-5 stages. Document in IMPLEMENTATION_PLAN.md:

1
2
3
4
5
## Stage N: [Name]
**Goal**: [Specific deliverable]
**Success Criteria**: [Testable outcomes]
**Tests**: [Specific test cases]
**Status**: [Not Started|In Progress|Complete]
  • Update status as you progress
  • Remove file when all stages are done

2. Implementation Flow

  1. Understand - Study existing patterns in codebase
  2. Test - Write test first (red)
  3. Implement - Minimal code to pass (green)
  4. Refactor - Clean up with tests passing
  5. Commit - With clear message linking to plan

3. When Stuck (After 3 Attempts)

CRITICAL: Maximum 3 attempts per issue, then STOP.

  1. Document what failed:
  2. What you tried
  3. Specific error messages

  4. Why you think it failed

  5. Research alternatives:

  6. Find 2-3 similar implementations

  7. Note different approaches used

  8. Question fundamentals:

  9. Is this the right abstraction level?
  10. Can this be split into smaller problems?

  11. Is there a simpler approach entirely?

  12. Try different angle:

  13. Different library/framework feature?
  14. Different architectural pattern?
  15. Remove abstraction instead of adding?

Decision Framework

When multiple valid approaches exist, choose based on:

  1. Testability - Can I easily test this?
  2. Readability - Will someone understand this in 6 months?
  3. Consistency - Does this match project patterns?
  4. Simplicity - Is this the simplest solution that works?
  5. Reversibility - How hard to change later?

Project Integration

Learning the Codebase

  • Find 3 similar features/components
  • Identify common patterns and conventions
  • Use same libraries/utilities when possible
  • Follow existing test patterns

Important Reminders

NEVER:

  • Use --no-verify to bypass commit hooks
  • Disable tests instead of fixing them
  • Commit code that doesn't compile
  • Make assumptions - verify with existing code

ALWAYS:

  • Commit working code incrementally
  • Update plan documentation as you go
  • Learn from existing implementations
  • Stop after 3 failed attempts and reassess

Form Migration Guide

The application contains 200+ form components across two patterns, showing gradual migration from Redux Form to React Final Form.

Form Patterns Comparison

Aspect Redux Form (Legacy, 59.5%) React Final Form (Modern, 30.5%) VStepperForm (Multi-step, 10%)
State Storage Redux store Local component state Shared across steps
Performance Can cause unnecessary re-renders Optimized subscription model Step-based validation
Complexity More boilerplate required Minimal boilerplate Step progression
Persistence Persists across unmounts Local to component lifecycle Visual progress indicators
Integration Deep Redux integration Isolated, no external dependencies Complex deployments

Implementation Examples

Redux Form (Legacy)

1
2
3
4
5
6
export const PolicyCreateForm: FC<PolicyCreateFormProps> = (props) => (
  <FormContainer submitting={props.submitting}>
    <NumberField name="limit_cost" validate={required} />
    <SelectField name="actions" validate={required} />
  </FormContainer>
);

React Final Form (Modern)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<Form
  onSubmit={onSubmit}
  render={({ handleSubmit, submitting, invalid }) => (
    <form onSubmit={handleSubmit}>
      <OrganizationGroup />
      <NameGroup />
      <SubmitButton submitting={submitting} disabled={invalid} />
    </form>
  )}
/>

Field Group Pattern

React Final Form uses reusable field groups for better organization:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
export const NameGroup = ({ customer }) => (
  <FormGroup label={translate('Project name')} required>
    <Field
      component={StringField as any}
      name="name"
      validate={validateProjectName}
      customer={customer}
    />
  </FormGroup>
);

Benefits: Separation of concerns, reusability, maintainability, testability

Key Patterns & Best Practices

Validation

1
2
export const validateProjectName = (value, _, props) =>
  checkDuplicate(value, props) || checkPattern(value);

Async Data Integration

1
2
3
4
const { data, isLoading, error, refetch } = useQuery({
  queryKey: ['CustomerProjects', selectedCustomer?.uuid],
  queryFn: () => fetchCustomerProjects(selectedCustomer.uuid),
});

Modern Form Submission

1
2
3
4
5
6
7
8
9
const onSubmit = async (formData) => {
  try {
    await projectsCreate({ body: formData });
    showSuccess(translate('Project created'));
    closeDialog();
  } catch (e) {
    showErrorResponse(e, translate('Unable to create project'));
  }
};

Migration Strategy

  • New Components: Use React Final Form
  • Legacy Components: Maintain Redux Form
  • Hybrid Support: Common field components work with both
  • Gradual Migration: Phase out Redux Form over time

Migration Detailed Guidelines

Form Distribution

  • Redux Form (Legacy): 119 forms (59.5%) - being phased out
  • React Final Form (Modern): 61 forms (30.5%) - preferred for new development
  • VStepperForm (Multi-step): 20 forms (10%) - complex deployments

Key Forms by Category

  • User/Auth: SigninForm, KeyCreateDialog (React Final Form)
  • Projects: ProjectCreateDialog (React Final Form), team management (Redux Form)
  • Resources: OpenStack/VMware/Azure provider configs (mostly Redux Form)
  • Administration: Mixed - newer ones use React Final Form
  • Marketplace: DeployForm (Redux Form), newer policy forms (React Final Form)

Post-Migration Cleanup

Essential Commands:

1
2
3
4
yarn deps:unused           # Remove unused dependencies
yarn lint:check           # Verify code standards
yarn test path/to/tests   # Validate functionality
yarn tsc --noEmit         # Check TypeScript compilation

Cleanup Checklist:

  • Remove unused Redux Form constants (FORM_ID)
  • Convert exported interfaces to internal if only used within component
  • Delete orphaned Redux Form files
  • Update imports to remove unused dependencies
  • Verify form context boundaries for React Final Form
  • Test modal structure and submit button access

Error Handling Migration

Issue: Avoid unhandled promise rejections when migrating error handling.

Solution: Don't re-throw errors after showErrorResponse():

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// ❌ Before (problematic)
catch (e) {
  showErrorResponse(e, translate('Unable to create key.'));
  throw e; // Causes unhandled promise rejection
}

// ✅ After (correct)
catch (e) {
  showErrorResponse(e, translate('Unable to create key.'));
  // Error handled, no re-throw needed
}

Component Migration Patterns

Key Changes in Migration

  1. Form State: Redux Form HOC → React Final Form <Form> component
  2. Initial Values: useEffect with change action → initialValues prop
  3. Error Handling: Redux actions → useNotify hook
  4. Component Structure: FormContainer wrapper → render prop pattern

Field Migration

1
2
3
4
5
6
7
8
9
// ✅ Standard pattern (preferred)
<Field
  component={StringField as any}
  name="username"
  validate={required}
/>

// ❌ Avoid creating typed adapters
const TypedNumberField = Field as React.ComponentType<any>;

Array Field Migration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
// Before: Redux Form
const comp = fields.get(i);

// After: React Final Form
const comp = fields.value[i];

// Setup with array mutators
<Form
  mutators={{ ...arrayMutators }}
  render={({ handleSubmit }) => (
    <form onSubmit={handleSubmit}>
      <PolicyCreateForm {...props} />
    </form>
  )}
/>

SDK Types Best Practices

  • Use import { type ComponentUsage } from 'waldur-js-client'
  • Prefer SDK types over custom interfaces
  • Handle type conversions: parseFloat(component.usage)

Modal Form Architecture Migration

Key Issue: React Final Form context boundaries - submit buttons must be inside <Form> component.

Problem: useFormState called outside form context:

1
2
3
4
// ❌ Problematic structure
<ModalDialog footer={<SubmitButton />}>
  <Form><ResourceForm /></Form>
</ModalDialog>

Solution: Move submit button inside form context:

1
2
3
4
5
6
7
8
9
// ✅ Correct structure
<ModalDialog>
  <Form>
    <ResourceForm />
    <div className="modal-footer">
      <SubmitButton />
    </div>
  </Form>
</ModalDialog>

Migration Steps:

  1. Move submit button inside <Form> render function
  2. Use modal-footer class for styling consistency
  3. Remove footer prop from ModalDialog
  4. Test form state access (useFormState, useField)

FormGroup Components

Two Types Available:

  1. @waldur/form/FormGroup - Redux Form wrapper with comprehensive state management
  2. @waldur/marketplace/offerings/FormGroup - Simple wrapper for labels/help text (preferred for React Final Form)

FormGroup Migration Patterns

Replace Manual Label/Field Combinations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
// ❌ Before - Repetitive manual structure
<div className="mb-7">
  <label className="form-label fw-bolder text-dark fs-6 required">
    {translate('Username')}
  </label>
  <Field component={StringField as any} name="username" />
</div>

// ✅ After - Clean FormGroup wrapper
<FormGroup label={translate('Username')} required>
  <Field component={StringField as any} name="username" />
</FormGroup>

Convert Manual Tooltips to Help Props

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
// ❌ Before - Manual tooltip implementation
<label>
  {translate('Plan')}
  <Tip label={translate('Help text')}>
    <QuestionIcon />
  </Tip>
</label>

// ✅ After - Built-in help prop
<FormGroup
  label={translate('Plan')}
  help={translate('Help text')}
>
  <Field component={SelectField as any} name="period" />
</FormGroup>

Best Practices

  1. Props Effectiveness: hideLabel, spaceless don't work with direct Field usage
  2. CSS Classes: Verify classes exist (avoid non-existent Tailwind classes like space-y-4)
  3. Translations: Make all text including prepositions translatable
  4. FormGroup Choice: Use marketplace FormGroup for React Final Form

Architecture Benefits

  • Flexibility: Multiple form approaches for different use cases
  • Consistency: Shared field components across form systems
  • Performance: Modern forms use optimized re-rendering
  • Maintainability: Clear separation between legacy and modern patterns
  • Developer Experience: Reduced boilerplate in new forms

Multilingual user interface

Workflow looks as following:

Markup TSX code using translate function. For example: translate('User details')

Always mark complete sentences for translation. If you combine fragments at runtime, there is no way for the translator to construct a proper sentence in their language. Do not combine strings together at runtime.

If you need to render JSX element inside of translated string, you should use formatJsxTemplate function:

1
2
3
4
translate('Opened by {user} at {date}', {
  user: <IssueUser item={item} />,
  date: formatDate(item.created),
}, formatJsxTemplate)

If translated string should be rendered inside of JSX element, you should use formatJsx function:

1
2
3
4
5
translate(
  'You have not added any SSH keys to your <Link>profile</Link>.',
  { Link: (s) => <Link state="profile.keys">{s}</Link> },
  formatJsx,
)

Translation template is created automatically. It will extract strings from TS and TSX files and put it in template.json. JSON files are synced with Localazy service by GitLab CI pipelines. Current user locale is stored in auth storage.

Role-based access control

Introduction

Waldur authorization system determines what user can do. It consists of permissions and roles. Permission is unique string designating action to be executed. Role is named set of permissions.

Permissions are defined in PermissionEnum which is automatically generated from backend code and pushed to fronted code by GitLab CI. Most of the time you're going to use hasPermission function which checks, whether user is allowed to perform action on given customer, project or offering. The following example shows how to check whether user is allowed to create offering in organization.

1
2
3
4
5
6
7
import { PermissionEnum } from '@waldur/permissions/enums';
import { hasPermission } from '@waldur/permissions/hasPermission';

hasPermission(user, {
  permission: PermissionEnum.CREATE_OFFERING,
  customerId: customer.uuid,
})

Migration examples

Previously we have relied on hard-coded roles, such as customer owner and project manager. Migration to dynamic roles on frontend is relatively straightforward process. Consider the following example.

1
2
3
4
5
6
7
8
9
export const AcceptAction = (props) => {
  const isOwnerOrStaff = useSelector(isOwnerOrStaffSelector);
  const isServiceManager = useSelector(isServiceManagerSelector);
  if (!isOwnerOrStaff && !isServiceManager) {
    return null;
  } else {
    return <Button/>;
  }
}

As you may see, we have relied on selectors with hard-coded roles. The main drawback of this approach is that it is very hard to inspect who can do what without reading all source code. And it is even hard to adjust this behaviour. Contrary to its name, by using dynamic roles we don't need to care much about roles though.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
export const AcceptAction = (props) => {
  if (!hasPermission(user, {
    permission: PermissionEnum.ACCEPT_BOOKING_REQUEST,
    customerId: customer.uuid,
  })) {
    return null;
  } else {
    return <Button/>;
  }
}

The only prerequisite of course is to ensure that backend uses dynamic roles too.

Local pipeline for developers: OpenAPI -> TypeScript SDK -> Homeport

This document describes the process of generating and linking the Waldur TypeScript SDK for local development. Although the SDK code is published to GitHub and npm repositories, a local pipeline is essential for developers who need to make changes to the SDK without using GitLab CI or work with the very latest OpenAPI definitions from Waldur MasterMind before they are officially released.

Prerequisites

Before proceeding, ensure you have the following installed and configured:

  • poetry: For managing Python dependencies in Waldur MasterMind.
  • npx: Comes with Node.js, used for executing Node.js package binaries.
  • yarn: For managing JavaScript dependencies in Waldur HomePort and Waldur TypeScript SDK.
  • Waldur MasterMind: Cloned and set up in a directory named waldur-mastermind.
  • Waldur HomePort: Cloned and set up in a directory named waldur-homeport.
  • Waldur TypeScript SDK: Cloned and set up in a directory named js-client.

These steps outline the process of generating the TypeScript SDK from the Waldur MasterMind OpenAPI schema and linking it to Waldur HomePort for local development.

  1. Generate the OpenAPI schema. This command uses waldur spectacular to generate the waldur-openapi-schema.yaml file. In waldur-mastermind directory, run:
1
poetry run waldur spectacular --file waldur-openapi-schema.yaml --fail-on-warn
  1. Generate TypeScript code from the OpenAPI schema. This step uses @hey-api/openapi-ts to convert the OpenAPI schema into TypeScript client code. In waldur-mastermind directory, run:
1
2
3
4
5
6
7
8
9
# generation
npx --yes @hey-api/openapi-ts@0.77.0

# post-processing
sed -i '/querySerializer: {/,/},/d' waldur-typescript-sdk/sdk.gen.ts
sed -i '1i export { formDataBodySerializer, RequestResult } from "./client";' waldur-typescript-sdk/index.ts

# copying
cp waldur-typescript-sdk ../js-client/src
  1. Building a local version of the Waldur SDK with Yarn. In the js-client directory, run:
1
yarn build
  1. Linking a local version of the Waldur SDK with Yarn. In the js-client directory, run:
1
yarn link
  1. Enable locally installed Waldur SDK in Waldur HomePort. This command will symlink your local Waldur SDK into Waldur HomePort for development and testing. In waldur-homeport directory, run:
1
yarn link waldur-js-client

Table component

  1. State management is done via useTable React hook.
  2. Table rendering is done using Table component.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import { translate } from '@waldur/i18n';
import Table from '@waldur/table/Table';
import { createFetcher } from '@waldur/table/api';
import { useTable } from '@waldur/table/useTable';

export const RolesList = () => {
  const tableProps = useTable({
    table: `RolesList`,
    fetchData: createFetcher('roles'),
  });

  return (
    <Table
      {...tableProps}
      columns={[
        {
          title: translate('Name'),
          render: ({ row }) => row.name,
        },
        {
          title: translate('Description'),
          render: ({ row }) => row.description,
        },
        {
          title: translate('Assigned users count'),
          render: ({ row }) => row.users_count,
        },
      ]}
    />
  );
};

Column definition consists of two mandatory fields: title and render.

fetchData property

The fetchData property is a function that retrieves data for the table. It should return a promise that resolves to an object containing rows and resultCount. The fetchData function can be customized to fetch data from any API endpoint and transform it as needed before passing it to the table.

Example:

1
2
3
4
const fetchData = () => Promise.resolve({
  rows: resource.items,
  resultCount: resource.items.length,
});

Export feature

Table component supports data export functionality. To enable it:

  1. Add enableExport prop to the Table component
  2. Configure export options in column definitions:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  title: 'Name',
  render: ({ row }) => row.name,
  export: 'name' // Use field directly
}

{
  title: 'Status',
  render: ({ row }) => row.status,
  export: row => formatStatus(row.status) // Custom formatter
}

{
  title: 'Actions',
  render: ({ row }) => <Button/>,
  export: false // Exclude from export
}

Optionally, specify exportTitle property for columns to customize the header in the exported file:

1
2
3
4
5
6
{
  title: 'Name',
  render: ({ row }) => row.name,
  export: 'name',
  exportTitle: 'User Name' // Custom header for export
}

Optional columns

Table component supports optional columns that can be toggled by users. Optional columns allow users to customize their view by showing/hiding specific columns.

  1. Add hasOptionalColumns prop to enable optional columns functionality

  2. Configure columns with:

    • id - unique column identifier
    • keys - defines which fields should be requested from API (allows optimization by fetching only needed fields)
    • optional - mark column as optional to allow toggling

  3. For actions column, you can specify mandatory fields that should always be fetched from API using mandatoryFields prop.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
export const UsersTable = () => {
  const tableProps = useTable({
    table: 'users',
    fetchData: createFetcher('users'),
  });

  return (
    <Table
      {...tableProps}
      hasOptionalColumns
      mandatoryFields={['uuid', 'name']}
      columns={[
        {
          id: 'name',
          title: translate('Name'),
          render: ({ row }) => row.name,
          optional: true,
          keys: ['name'],
        },
        {
          id: 'email',
          title: translate('Email'),
          render: ({ row }) => row.email,
          optional: true,
          keys: ['email'],
        },
        {
          id: 'role',
          title: translate('Role'),
          render: ({ row }) => row.role,
          optional: true,
          keys: ['role', 'permissions'],
        },
      ]}
    />
  );
};

Ordering feature

Table component supports column ordering. To enable it:

  1. Add enableOrdering prop to the Table component
  2. Configure columns with orderField property to specify which field should be used for ordering

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
export const UsersTable = () => {
  const tableProps = useTable({
    table: 'users',
    fetchData: createFetcher('users'),
  });

  return (
    <Table
      {...tableProps}
      enableOrdering
      columns={[
        {
          title: translate('Name'),
          render: ({ row }) => row.name,
          orderField: 'name',
        },
        {
          title: translate('Email'),
          render: ({ row }) => row.email,
          orderField: 'email',
        },
      ]}
    />
  );
};

When ordering is enabled, clicking on column headers will toggle between ascending and descending order.

Filters feature

Filters are defined using the filters prop of the Table component. This prop accepts a React component that renders the filter UI.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import { useSelector } from 'react-redux';
import { getFormValues } from 'redux-form';

const getFilterValues = getFormValues('FilterForm');

export const FilterSet = () => (
  <TableFilterItem title="Filter field" name="custom">
    <Field name="custom" component="input" />
  </TableFilterItem>
);

export const FilteredList = () => {
  const filter = useSelector(getFilterValues);
  const tableProps = useTable({
    table: 'FilteredList',
    fetchData: createFetcher('hooks'),
    filter,
  });

  return (
    <Table
      {...tableProps}
      filters={<FilterSet />}
    />
  );
};

Inline filters

The feature allows users to quickly filter table data by clicking values directly in the table cells, without manually setting filters. When column has inlineFilter property enabled:

  1. A filter icon appears when hovering over cells in that column
  2. Clicking the icon adds a filter using the cell's value
  3. The inlineFilter function transforms row data into the filter value format

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  title: translate('Organization'),
  render: ({ row }) => row.customer_name,
  filter: 'organization',  // Enable filtering
  inlineFilter: (row) => ({
    // Transform row data into filter value
    name: row.customer_name,
    uuid: row.customer_uuid
  })
}

Grid mode

Table component supports switching between table and grid views. In grid mode, data is displayed as cards in a responsive grid layout.

To enable grid mode:

  1. Add gridItem prop to specify the component used to render each item in grid view
  2. Optionally customize grid layout using gridSize prop which accepts Bootstrap column properties
  3. Set initialMode to 'grid' if you want grid view by default (table view is default)

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
export const GridListItem = ({ row }) => (
  <Card>
    <CardHeader>{row.name}</CardHeader>
    <CardBody>
      <p>{row.description}</p>
      <small>Users: {row.users_count}</small>
    </CardBody>
  </Card>
);

export const GridList = () => {
  const tableProps = useTable({
    table: 'GridList',
    fetchData: createFetcher('items'),
  });

  return (
    <Table
      {...tableProps}
      gridItem={GridListItem}
      gridSize="col-sm-6 col-md-4"
      initialMode="grid"
    />
  );
};

Terminology policy

We prefer British English over American English. For example, we use cancelled instead of canceled.

Should be applied for naming buttons, separate pages of the process and in list of actions.

Add / Remove

Should be used when an action of creating/adding or deleting/removing is applied to:

  • Organizations
  • Projects
  • Providers
  • VMs
  • Applications
  • SLA
  • SSH key
  • Team members

Import / Unlink

Should be used when an action of importing or unlinking / deleting a record without undeploying is applied to:

  • VMs

Please use "synchronise" instead of "pull" in action title.

Mocking HTTP Requests for Unit Tests

When writing unit tests for frontend components, it's crucial to isolate the component from external dependencies, especially network requests. Mocking HTTP requests allows us to simulate API responses and test our components in a predictable and controlled environment. This guide describes how to use nock, got, and React Testing Library (RTL) to achieve this. By following these patterns, you can effectively mock HTTP requests in your unit tests, leading to more robust and reliable components.

Key Libraries

  • Nock: A powerful HTTP server mocking and expectations library for Node.js. It allows you to intercept outgoing HTTP requests and provide custom responses.
  • Got: A human-friendly and powerful HTTP request library for Node.js. We use it in tests to trigger the mocked endpoints and wait for nock to resolve them.
  • React Testing Library (RTL): A library for testing React components in a way that resembles how users interact with them.

Basic Setup

To ensure a clean testing environment for each test case, we should set up nock before each test and clean up the mocks afterward. This is typically done in beforeEach and afterEach blocks.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import { render, screen, waitFor } from '@testing-library/react';
import { got } from 'got';
import nock from 'nock';
import { afterEach, beforeEach, describe, it } from 'vitest';

// It's a good practice to define the base URL of your API to avoid repetition.
const API_URL = '<http://example.com';>

describe('MyComponent', () => {
  beforeEach(() => {
    // Setup nock to intercept requests to our API.
    nock(API_URL)
      .get('/api/my-data/')
      .reply(200, { id: 1, name: 'Test Data' });
  });

  afterEach(() => {
    // Clean up all nock interceptors after each test.
    nock.cleanAll();
  });

  it('should fetch and display data', async () => {
    // Render your component which fetches data on mount.
    render(<MyComponent />);

    // Use got to trigger the request and wait for nock to handle it.
    await waitFor(() => got(`${API_URL}/api/my-data/`));

    // Assert that the component displays the mocked data.
    expect(screen.getByText('Test Data')).toBeInTheDocument();
  });
});

Mocking Different Scenarios

Successful GET Request

The example above shows a basic successful GET request. You can customize the response data to fit your test case.

1
2
3
4
5
6
  nock('<http://example.com>')
  .get('/api/organization-groups/')
  .reply(200, [
    { name: 'Group 1', uuid: 'group-1-uuid' },
    { name: 'Group 2', uuid: 'group-2-uuid' },
  ]);

Mocking Failed Requests

To test how your component handles API errors, you can mock a request to return an error status code.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
   nock('<http://example.com>')
  .get('/api/organization-groups/')
  .reply(400, { error: 'Invalid request' });

// In your test:
render(<MyComponent />);
await waitFor(() =>
  expect(
    screen.getByText('Unable to load organization groups.'),
  ).toBeInTheDocument(),
);

Testing

Unit tests

Unit tests are used for testing React components and utilities. They are written in .test.ts or .test.tsx files located next to the code they test.

Run tests using yarn test command.

Unit tests use written using:

Integration tests

Integration tests are implemented using Cypress framework.

  • Run all tests headless (CI mode): yarn ci:test
  • Open Cypress GUI (requires dev server running): yarn cypress open

Integration tests are located in:

  • cypress/e2e/ - Test specifications
  • cypress/fixtures/ - Test data
  • cypress/support/ - Custom commands and utilities

Ended: Ui

Ad-hoc scripts

This section describes different ad-hoc scripts used by Waldur developers.

Restore CPU/GPU/RAM usages for a month

Sometimes, Waldur can have issues with data correctness. They can be caused by different circumstansies, e.g. problems with data syncronization between Waldur backend and service provider software. In order to resolve these issues, a user can restore usage data with restore_usages.py script.

Generate openmetrics file with usages for several months

If a user needs to create openmetrics file with usages, e.g. for historical data backfilling in Prometheus, the generate_openmetrics_usages.py can be used.

If a user needs to remove a tenant with all related objects (instances, volumes, backups, etc.) manually, this script should be used. It removes all the tenants with names from tenant_names list using an OpenStack administrator project. Please, replace <main-tenant-uuid> (line 13) with the corresponding UUID of the admin tenant in Waldur.

Import projects with slug info

A CSV-file with the following format is required:

1
2
"id","unix_gid","valid_from","valid_to","accessible_from","accessible_to"
"abc","10000","01/1/2024","31/3/2024","05/1/2024","28/3/2024"

Put this file to the /tmp/projects-info.csv location and execute this script with your Waldur shell.

Migrate legacy SLURM allocations to a new SLURM-remote offering

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
from waldur_mastermind.marketplace import models as marketplace_models

COMPONENT_TYPE_MAP = {
    "cpu": "cpu",
    "gpu": "gres/gpu",
    "ram": "mem",
}


def migrate_legacy_allocation(
    resource: marketplace_models.Resource,
    offering_new: marketplace_models.Offering,
    dry_run=True,
):
    plan_old = resource.plan
    if dry_run:
        print("Dry-run migrating legacy allocation %s" % resource)
    else:
        print("Migrating legacy allocation %s" % resource)
        resource.offering = offering_new
        print("Updating resource plan to %s" % plan_new)
        resource.plan = plan_new
        resource.save(update_fields=["offering", "plan"])
    try:
        for usage in resource.usages.all():
            new_component = offering_new.components.get(
                type=COMPONENT_TYPE_MAP[usage.component.type]
            )
            if dry_run:
                print("Dry-run switching component usage %s" % usage)
            else:
                print("Switching usage %s" % usage)
                usage.component = new_component
                usage.save(update_fields=["component"])
    except Exception as e:
        if dry_run:
            print("Dry-run Rolling back resource offering and plan because of %s" % e)
        else:
            print("Rolling back resource offering and plan because of %s" % e)
            resource.offering = offering_old
            resource.plan = plan_old
            resource.save(update_fields=["offering", "plan"])

offering_old_uuid = "<LEGACY_OFFERING_UUID>"
offering_new_uuid = "<NEW_OFFERING_UUID>"
offering_old = marketplace_models.Offering.objects.get(uuid=offering_old_uuid)
offering_new = marketplace_models.Offering.objects.get(uuid=offering_new_uuid)
plan_new = offering_new.plans.first()

legacy_allocations = marketplace_models.Resource.objects.filter(offering=offering_old)

i = 1
legacy_allocations_count = legacy_allocations.count()
for legacy_allocation in legacy_allocations:
    print("Processing resource %s/%s" % (i, legacy_allocations_count))
    try:
        migrate_legacy_allocation(legacy_allocation, offering_new, dry_run=False)
    except Exception as e:
        print("Failed to migrate allocation %s: %s" % (legacy_allocation, e))
    i += 1

Events

Eventgroup.access_subnets

  • access_subnet_creation_succeeded
  • access_subnet_deletion_succeeded
  • access_subnet_update_succeeded

Eventgroup.auth

  • auth_logged_in_with_username
  • auth_logged_out
  • auth_login_failed_with_username
  • token_created
  • token_lifetime_updated

Eventgroup.call

  • call_document_added
  • call_document_removed

Eventgroup.credits

  • allowed_offerings_have_been_updated
  • create_of_credit_by_staff
  • reduction_of_customer_credit
  • reduction_of_customer_credit_due_to_minimal_consumption
  • reduction_of_customer_expected_consumption
  • reduction_of_project_credit
  • reduction_of_project_credit_due_to_minimal_consumption
  • reduction_of_project_expected_consumption
  • roll_back_customer_credit
  • roll_back_project_credit
  • set_to_zero_overdue_credit
  • update_of_credit_by_staff

Eventgroup.customers

  • allowed_offerings_have_been_updated
  • create_of_credit_by_staff
  • customer_creation_succeeded
  • customer_deletion_succeeded
  • customer_update_succeeded
  • payment_added
  • payment_removed
  • reduction_of_customer_credit
  • reduction_of_customer_credit_due_to_minimal_consumption
  • reduction_of_customer_expected_consumption
  • reduction_of_project_credit
  • reduction_of_project_credit_due_to_minimal_consumption
  • reduction_of_project_expected_consumption
  • roll_back_customer_credit
  • roll_back_project_credit
  • set_to_zero_overdue_credit
  • update_of_credit_by_staff

Eventgroup.invoices

  • allowed_offerings_have_been_updated
  • create_of_credit_by_staff
  • invoice_canceled
  • invoice_created
  • invoice_item_created
  • invoice_item_deleted
  • invoice_item_updated
  • invoice_paid
  • payment_created
  • payment_removed
  • reduction_of_customer_credit
  • reduction_of_customer_credit_due_to_minimal_consumption
  • reduction_of_customer_expected_consumption
  • reduction_of_project_credit
  • reduction_of_project_credit_due_to_minimal_consumption
  • reduction_of_project_expected_consumption
  • roll_back_customer_credit
  • roll_back_project_credit
  • set_to_zero_overdue_credit
  • update_of_credit_by_staff

Eventgroup.offering_accounting

  • marketplace_offering_component_created
  • marketplace_offering_component_deleted
  • marketplace_offering_component_updated
  • marketplace_plan_archived
  • marketplace_plan_component_current_price_updated
  • marketplace_plan_component_future_price_updated
  • marketplace_plan_component_quota_updated
  • marketplace_plan_created
  • marketplace_plan_deleted
  • marketplace_plan_updated

Eventgroup.permissions

  • role_granted
  • role_revoked
  • role_updated

Eventgroup.projects

  • project_creation_succeeded
  • project_deletion_succeeded
  • project_deletion_triggered
  • project_update_request_approved
  • project_update_request_created
  • project_update_request_rejected
  • project_update_succeeded

Eventgroup.proposal

  • proposal_canceled
  • proposal_document_added
  • proposal_document_removed

Eventgroup.providers

  • marketplace_resource_create_canceled
  • marketplace_resource_create_failed
  • marketplace_resource_create_requested
  • marketplace_resource_create_succeeded
  • marketplace_resource_terminate_failed
  • marketplace_resource_terminate_requested
  • marketplace_resource_terminate_succeeded
  • marketplace_resource_update_failed
  • marketplace_resource_update_limits_failed
  • marketplace_resource_update_limits_succeeded
  • marketplace_resource_update_requested
  • resource_robot_account_created
  • resource_robot_account_deleted
  • resource_robot_account_state_changed
  • resource_robot_account_updated

Eventgroup.resources

  • marketplace_order_approved
  • marketplace_order_completed
  • marketplace_order_created
  • marketplace_order_failed
  • marketplace_order_rejected
  • marketplace_order_terminated
  • marketplace_order_unlinked
  • marketplace_resource_create_canceled
  • marketplace_resource_create_failed
  • marketplace_resource_create_requested
  • marketplace_resource_create_succeeded
  • marketplace_resource_downscaled
  • marketplace_resource_erred_on_backend
  • marketplace_resource_paused
  • marketplace_resource_terminate_canceled
  • marketplace_resource_terminate_failed
  • marketplace_resource_terminate_requested
  • marketplace_resource_terminate_succeeded
  • marketplace_resource_unlinked
  • marketplace_resource_update_canceled
  • marketplace_resource_update_end_date_succeeded
  • marketplace_resource_update_failed
  • marketplace_resource_update_limits_failed
  • marketplace_resource_update_limits_succeeded
  • marketplace_resource_update_requested
  • marketplace_resource_update_succeeded
  • openstack_floating_ip_attached
  • openstack_floating_ip_connected
  • openstack_floating_ip_description_updated
  • openstack_floating_ip_detached
  • openstack_floating_ip_disconnected
  • openstack_network_cleaned
  • openstack_network_created
  • openstack_network_deleted
  • openstack_network_imported
  • openstack_network_pulled
  • openstack_network_updated
  • openstack_port_cleaned
  • openstack_port_created
  • openstack_port_deleted
  • openstack_port_imported
  • openstack_port_pulled
  • openstack_port_updated
  • openstack_router_updated
  • openstack_security_group_cleaned
  • openstack_security_group_created
  • openstack_security_group_deleted
  • openstack_security_group_imported
  • openstack_security_group_pulled
  • openstack_security_group_rule_cleaned
  • openstack_security_group_rule_created
  • openstack_security_group_rule_deleted
  • openstack_security_group_rule_imported
  • openstack_security_group_rule_updated
  • openstack_security_group_updated
  • openstack_server_group_cleaned
  • openstack_server_group_created
  • openstack_server_group_deleted
  • openstack_server_group_imported
  • openstack_server_group_pulled
  • openstack_subnet_cleaned
  • openstack_subnet_created
  • openstack_subnet_deleted
  • openstack_subnet_imported
  • openstack_subnet_pulled
  • openstack_subnet_updated
  • openstack_tenant_quota_limit_updated
  • resource_assign_floating_ip_failed
  • resource_assign_floating_ip_scheduled
  • resource_assign_floating_ip_succeeded
  • resource_attach_failed
  • resource_attach_scheduled
  • resource_attach_succeeded
  • resource_change_flavor_failed
  • resource_change_flavor_scheduled
  • resource_change_flavor_succeeded
  • resource_creation_failed
  • resource_creation_scheduled
  • resource_creation_succeeded
  • resource_deletion_failed
  • resource_deletion_scheduled
  • resource_deletion_succeeded
  • resource_detach_failed
  • resource_detach_scheduled
  • resource_detach_succeeded
  • resource_extend_failed
  • resource_extend_scheduled
  • resource_extend_succeeded
  • resource_extend_volume_failed
  • resource_extend_volume_scheduled
  • resource_extend_volume_succeeded
  • resource_import_succeeded
  • resource_pull_failed
  • resource_pull_scheduled
  • resource_pull_succeeded
  • resource_restart_failed
  • resource_restart_scheduled
  • resource_restart_succeeded
  • resource_retype_failed
  • resource_retype_scheduled
  • resource_retype_succeeded
  • resource_robot_account_created
  • resource_robot_account_deleted
  • resource_robot_account_state_changed
  • resource_robot_account_updated
  • resource_start_failed
  • resource_start_scheduled
  • resource_start_succeeded
  • resource_stop_failed
  • resource_stop_scheduled
  • resource_stop_succeeded
  • resource_unassign_floating_ip_failed
  • resource_unassign_floating_ip_scheduled
  • resource_unassign_floating_ip_succeeded
  • resource_update_allowed_address_pairs_failed
  • resource_update_allowed_address_pairs_scheduled
  • resource_update_allowed_address_pairs_succeeded
  • resource_update_floating_ips_failed
  • resource_update_floating_ips_scheduled
  • resource_update_floating_ips_succeeded
  • resource_update_ports_failed
  • resource_update_ports_scheduled
  • resource_update_ports_succeeded
  • resource_update_security_groups_failed
  • resource_update_security_groups_scheduled
  • resource_update_security_groups_succeeded
  • resource_update_succeeded

Eventgroup.review

  • review_canceled

Eventgroup.ssh

  • ssh_key_creation_succeeded
  • ssh_key_deletion_succeeded

Eventgroup.support

  • attachment_created
  • attachment_deleted
  • attachment_updated
  • issue_creation_succeeded
  • issue_deletion_succeeded
  • issue_update_succeeded

Eventgroup.users

  • auth_logged_in_with_saml2
  • auth_logged_out_with_saml2
  • freeipa_profile_created
  • freeipa_profile_deleted
  • freeipa_profile_disabled
  • freeipa_profile_enabled
  • marketplace_offering_user_created
  • marketplace_offering_user_deleted
  • marketplace_offering_user_restriction_updated
  • ssh_key_creation_succeeded
  • ssh_key_deletion_succeeded
  • user_activated
  • user_creation_succeeded
  • user_deactivated
  • user_deletion_succeeded
  • user_details_update_succeeded
  • user_has_been_created_by_staff
  • user_password_updated
  • user_password_updated_by_staff
  • user_update_succeeded

Registered Handlers

This document lists all registered signal handlers found in the system.

Application: waldur_auth_saml2

Handler Name Signal Type Sender Description
update_registration_method Unknown Signal core.User Update user's registration method to SAML2.

Application: waldur_autoprovisioning

Handler Name Signal Type Sender Description
handle_new_user Django Signal (post_save) core.User Create project and order for new user based on autoprovisioning rules.

Application: waldur_core

Handler Name Signal Type Sender Description
change_email_has_been_requested Django Signal (post_save) core.ChangeEmailRequest Send a notification when a user requests to change their email.
change_users_quota Custom Signal (role_granted) — Update the user count quota for a customer when a user's role is changed.
change_users_quota Custom Signal (role_revoked) — Update the user count quota for a customer when a user's role is changed.
constance_updated Custom Signal (config_updated) — Clear the API configuration cache when a Constance setting is updated.
create_auth_token Django Signal (post_save) core.User Create a token for a new user.
create_existing_projects_completions Django Signal (post_save) structure.Customer Create ChecklistCompletion for existing projects when customer checklist is updated.
create_notification_about_permission_request_has_been_submitted Django Signal (post_save) users.PermissionRequest Send a notification when a permission request has been submitted.
create_project_metadata_completion Django Signal (post_save) structure.Project Create ChecklistCompletion for project metadata when a project is created.
deactivate_user_if_no_roles Custom Signal (role_revoked) — Deactivate a user if they no longer have any active roles.
delete_error_message Custom Signal (post_transition) structure.ServiceSettings Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) structure.SharedServiceSettings Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) structure.PrivateServiceSettings Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_aws.Instance Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_aws.Volume Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.ResourceGroup Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.StorageAccount Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.Network Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.SubNet Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.SecurityGroup Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.NetworkInterface Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.PublicIP Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.VirtualMachine Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.SQLServer Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_azure.SQLDatabase Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_digitalocean.Droplet Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) google.GoogleCalendar Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Tenant Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.ServerGroup Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.SecurityGroup Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.FloatingIP Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Router Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Network Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.SubNet Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Port Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Volume Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Snapshot Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Instance Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) openstack.Backup Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_openstack_replication.Migration Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_rancher.Cluster Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_rancher.Node Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_rancher.HPA Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_rancher.Application Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_rancher.Ingress Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_rancher.Service Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_slurm.Allocation Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_vmware.VirtualMachine Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_vmware.Port Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_vmware.Disk Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) waldur_firecrest.Job Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) support.Issue Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) support.Comment Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) support.Attachment Delete error message if instance state changed from erred
delete_error_message Custom Signal (post_transition) support.Feedback Delete error message if instance state changed from erred
delete_project_metadata_completions Django Signal (post_save) structure.Customer Delete ChecklistCompletions when customer's project metadata checklist is removed.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) structure.Customer Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) structure.Project Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) structure.ServiceSettings Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) structure.SharedServiceSettings Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) structure.PrivateServiceSettings Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) openstack.Tenant Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) marketplace.Category Delete all quotas related to a model when it is deleted.
delete_quotas_when_model_is_deleted Django Signal (pre_delete) marketplace.Offering Delete all quotas related to a model when it is deleted.
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_aws.Instance If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_aws.Volume If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.ResourceGroup If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.StorageAccount If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.Network If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.SubNet If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.SecurityGroup If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.NetworkInterface If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.PublicIP If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.VirtualMachine If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.SQLServer If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_azure.SQLDatabase If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_digitalocean.Droplet If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Tenant If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.ServerGroup If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.SecurityGroup If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.FloatingIP If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Router If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Network If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.SubNet If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Port If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Volume If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Snapshot If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Instance If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) openstack.Backup If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_rancher.Cluster If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_rancher.Application If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_rancher.Ingress If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_rancher.Service If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_slurm.Allocation If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_vmware.VirtualMachine If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_vmware.Port If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_vmware.Disk If VM that contains service settings were deleted - all settings
delete_service_settings_on_scope_delete Django Signal (pre_delete) waldur_firecrest.Job If VM that contains service settings were deleted - all settings
delete_stale_event_subscriptions Django Signal (post_delete) authtoken.Token Delete stale event subscriptions for a user when their token is deleted.
handle_aggregated_quotas Django Signal (post_save) quotas.QuotaUsage Call aggregated quotas fields update methods
handle_aggregated_quotas Django Signal (pre_delete) quotas.QuotaUsage Call aggregated quotas fields update methods
log_access_subnet_deletion_succeeded Django Signal (post_delete) structure.AccessSubnet Log successful access subnet deletion.
log_access_subnet_save Django Signal (post_save) structure.AccessSubnet Log access subnet creation and updates.
log_customer_delete Django Signal (post_delete) structure.Customer Log customer deletion.
log_customer_save Django Signal (post_save) structure.Customer Log customer creation and updates.
log_project_delete Django Signal (post_delete) structure.Project Log project deletion.
log_project_save Django Signal (post_save) structure.Project Log project creation and updates.
log_resource_action Custom Signal (post_transition) waldur_aws.Instance Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_aws.Volume Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.ResourceGroup Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.StorageAccount Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.Network Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.SubNet Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.SecurityGroup Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.NetworkInterface Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.PublicIP Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.VirtualMachine Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.SQLServer Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_azure.SQLDatabase Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_digitalocean.Droplet Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Tenant Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.ServerGroup Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.SecurityGroup Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.FloatingIP Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Router Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Network Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.SubNet Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Port Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Volume Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Snapshot Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Instance Log resource state transitions.
log_resource_action Custom Signal (post_transition) openstack.Backup Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_rancher.Cluster Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_rancher.Application Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_rancher.Ingress Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_rancher.Service Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_slurm.Allocation Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_vmware.VirtualMachine Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_vmware.Port Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_vmware.Disk Log resource state transitions.
log_resource_action Custom Signal (post_transition) waldur_firecrest.Job Log resource state transitions.
log_resource_creation_scheduled Django Signal (post_save) waldur_aws.Instance Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_aws.Volume Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.ResourceGroup Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.StorageAccount Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.Network Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.SubNet Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.SecurityGroup Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.NetworkInterface Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.PublicIP Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.VirtualMachine Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.SQLServer Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_azure.SQLDatabase Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_digitalocean.Droplet Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Tenant Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.ServerGroup Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.SecurityGroup Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.FloatingIP Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Router Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Network Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.SubNet Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Port Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Volume Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Snapshot Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Instance Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) openstack.Backup Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_rancher.Cluster Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_rancher.Application Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_rancher.Ingress Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_rancher.Service Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_slurm.Allocation Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_vmware.VirtualMachine Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_vmware.Port Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_vmware.Disk Log scheduled resource creation.
log_resource_creation_scheduled Django Signal (post_save) waldur_firecrest.Job Log scheduled resource creation.
log_resource_deleted Django Signal (pre_delete) waldur_aws.Instance Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_aws.Volume Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.ResourceGroup Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.StorageAccount Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.Network Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.SubNet Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.SecurityGroup Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.NetworkInterface Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.PublicIP Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.VirtualMachine Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.SQLServer Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_azure.SQLDatabase Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_digitalocean.Droplet Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Tenant Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.ServerGroup Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.SecurityGroup Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.FloatingIP Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Router Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Network Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.SubNet Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Port Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Volume Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Snapshot Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Instance Log resource deletion.
log_resource_deleted Django Signal (pre_delete) openstack.Backup Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_rancher.Cluster Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_rancher.Application Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_rancher.Ingress Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_rancher.Service Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_slurm.Allocation Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_vmware.VirtualMachine Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_vmware.Port Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_vmware.Disk Log resource deletion.
log_resource_deleted Django Signal (pre_delete) waldur_firecrest.Job Log resource deletion.
log_resource_imported Custom Signal (resource_imported) waldur_aws.Instance Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_aws.Volume Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.ResourceGroup Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.StorageAccount Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.Network Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.SubNet Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.SecurityGroup Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.NetworkInterface Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.PublicIP Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.VirtualMachine Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.SQLServer Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_azure.SQLDatabase Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_digitalocean.Droplet Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Tenant Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.ServerGroup Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.SecurityGroup Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.FloatingIP Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Router Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Network Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.SubNet Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Port Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Volume Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Snapshot Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Instance Log resource import.
log_resource_imported Custom Signal (resource_imported) openstack.Backup Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_rancher.Cluster Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_rancher.Application Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_rancher.Ingress Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_rancher.Service Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_slurm.Allocation Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_vmware.VirtualMachine Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_vmware.Port Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_vmware.Disk Log resource import.
log_resource_imported Custom Signal (resource_imported) waldur_firecrest.Job Log resource import.
log_role_granted Custom Signal (role_granted) — Log the event of a user being granted a role.
log_role_revoked Custom Signal (role_revoked) — Log the event of a user having a role revoked.
log_role_updated Custom Signal (role_updated) — Log the event of a user's role being updated.
log_ssh_key_delete Django Signal (post_delete) core.SshPublicKey Log SSH key deletion events.
log_ssh_key_save Django Signal (post_save) core.SshPublicKey Log SSH key creation events.
log_token_create Django Signal (post_save) authtoken.Token Log token creation events.
log_user_delete Django Signal (post_delete) core.User Log user deletion events.
log_user_save Django Signal (post_save) core.User Log user creation, update, and activation/deactivation events.
permissions_request_approved Custom Signal (permissions_request_approved) users.PermissionRequest Send a notification when a permission request has been approved.
preserve_fields_before_update Django Signal (pre_save) core.User Preserve fields of a user instance before it is updated.
process_hook Django Signal (post_save) logging.Event Process a hook for a given event.
projects_customer_has_been_changed Custom Signal (project_moved) structure.Project Recalculate quotas when a project's customer has been changed.
recalculate_count_quota Django Signal (post_save) structure.Project Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_aws.Instance Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_aws.Volume Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.ResourceGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.StorageAccount Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.Network Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.SubNet Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.SecurityGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.NetworkInterface Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.PublicIP Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.VirtualMachine Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.SQLServer Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_azure.SQLDatabase Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_digitalocean.Droplet Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Tenant Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.ServerGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.SecurityGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.FloatingIP Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Router Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Network Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.SubNet Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Port Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Volume Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Snapshot Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Instance Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) openstack.Backup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_rancher.Cluster Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_rancher.Application Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_rancher.Ingress Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_rancher.Service Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_slurm.Allocation Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_vmware.VirtualMachine Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_vmware.Port Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_vmware.Disk Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) waldur_firecrest.Job Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_save) marketplace.Order Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) structure.Project Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_aws.Instance Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_aws.Volume Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.ResourceGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.StorageAccount Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.Network Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.SubNet Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.SecurityGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.NetworkInterface Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.PublicIP Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.VirtualMachine Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.SQLServer Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_azure.SQLDatabase Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_digitalocean.Droplet Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Tenant Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.ServerGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.SecurityGroup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.FloatingIP Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Router Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Network Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.SubNet Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Port Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Volume Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Snapshot Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Instance Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) openstack.Backup Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_rancher.Cluster Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_rancher.Application Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_rancher.Ingress Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_rancher.Service Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_slurm.Allocation Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_vmware.VirtualMachine Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_vmware.Port Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_vmware.Disk Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) waldur_firecrest.Job Recalculate count quota when an instance is created or deleted.
recalculate_count_quota Django Signal (post_delete) marketplace.Order Recalculate count quota when an instance is created or deleted.
revoke_roles_on_project_deletion Django Signal (pre_delete) structure.Project When project is deleted, all project permissions are cascade deleted
set_default_token_lifetime Django Signal (post_save) core.User Set the default token lifetime for a new user.
update_customer_users_count Custom Signal (recalculate_quotas) — Update the user count for all customers.
update_resource_start_time Django Signal (post_save) waldur_aws.Instance Update the start time of a resource when its runtime state changes.
update_resource_start_time Django Signal (post_save) waldur_azure.VirtualMachine Update the start time of a resource when its runtime state changes.
update_resource_start_time Django Signal (post_save) waldur_digitalocean.Droplet Update the start time of a resource when its runtime state changes.
update_resource_start_time Django Signal (post_save) openstack.Instance Update the start time of a resource when its runtime state changes.

Application: waldur_freeipa

Handler Name Signal Type Sender Description
log_profile_deleted Django Signal (pre_delete) waldur_freeipa.Profile Log FreeIPA profile deletion events.
log_profile_event Django Signal (pre_save) waldur_freeipa.Profile Log FreeIPA profile creation, enable, and disable events.
schedule_ssh_key_sync_when_key_is_created Django Signal (post_save) core.SshPublicKey Schedule an SSH key synchronization task when a key is created.
schedule_ssh_key_sync_when_key_is_deleted Django Signal (pre_delete) core.SshPublicKey Schedule an SSH key synchronization task when a key is deleted.
schedule_sync Django Signal (post_save) structure.Customer Schedule a synchronization task.
schedule_sync Django Signal (post_save) structure.Project Schedule a synchronization task.
schedule_sync Django Signal (pre_delete) structure.Customer Schedule a synchronization task.
schedule_sync Django Signal (pre_delete) structure.Project Schedule a synchronization task.
schedule_sync Custom Signal (role_granted) — Schedule a synchronization task.
schedule_sync Custom Signal (role_revoked) — Schedule a synchronization task.
schedule_sync_on_quota_change Django Signal (post_save) quotas.QuotaLimit Schedule a synchronization task when a quota is changed.
update_user Django Signal (post_save) core.User Update a user's FreeIPA profile when their user account is updated.

Application: waldur_lexis

Handler Name Signal Type Sender Description
request_ssh_key_for_heappe_robot_account Django Signal (post_save) marketplace.RobotAccount Request an SSH key for a HEAppE robot account.

Application: waldur_mastermind

Handler Name Signal Type Sender Description
add_call_managing_organization_uuid Custom Signal (pre_serializer_fields) CustomerSerializer Add a call managing organization UUID field to the serializer.
add_customer_credit Custom Signal (pre_serializer_fields) CustomerSerializer Add a customer credit field to the serializer.
add_customer_unallocated_credit Custom Signal (pre_serializer_fields) CustomerSerializer Add a customer unallocated credit field to the serializer.
add_google_calendar_info Custom Signal (pre_serializer_fields) ProviderOfferingDetailsSerializer Add a Google Calendar info field to the serializer.
add_google_calendar_info Custom Signal (pre_serializer_fields) PublicOfferingDetailsSerializer Add a Google Calendar info field to the serializer.
add_google_calendar_link Custom Signal (pre_serializer_fields) ProviderOfferingDetailsSerializer Add a Google Calendar link field to the serializer.
add_google_calendar_link Custom Signal (pre_serializer_fields) PublicOfferingDetailsSerializer Add a Google Calendar link field to the serializer.
add_integration_status Custom Signal (pre_serializer_fields) ProviderOfferingDetailsSerializer Add an integration status field to the serializer.
add_issue Custom Signal (pre_serializer_fields) OrderDetailsSerializer Add an issue field to the serializer.
add_maintenance_fields_to_admin_announcement_serializer Custom Signal (pre_serializer_fields) AdminAnnouncementSerializer Add maintenance-related fields to AdminAnnouncementSerializer when maintenance is scheduled.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackFloatingIPSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackSecurityGroupSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackServerGroupSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackPortSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackNetworkSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackSubNetSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackSnapshotSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackBackupSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AwsInstanceSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AzureVirtualMachineSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) DigitalOceanDropletSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackInstanceSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AwsVolumeSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AzureResourceGroupSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AzureSqlServerSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AzurePublicIPSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) AzureSqlDatabaseSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackTenantSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackRouterSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) OpenStackVolumeSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) RancherClusterSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) RancherApplicationSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) RancherIngressSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) RancherServiceSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) SlurmAllocationSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) VmwareVirtualMachineSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) VmwarePortSerializer Add marketplace offering related fields to the serializer.
add_marketplace_offering Custom Signal (pre_serializer_fields) VmwareDiskSerializer Add marketplace offering related fields to the serializer.
add_marketplace_resource_count Custom Signal (pre_serializer_fields) ProjectSerializer Add a marketplace resource count field to the serializer.
add_marketplace_resource_uuid Custom Signal (pre_serializer_fields) OpenStackNestedVolumeSerializer Add a marketplace resource UUID field to the serializer.
add_payment_profile Custom Signal (pre_serializer_fields) CustomerSerializer Add a payment profile field to the serializer.
add_price_estimate Custom Signal (pre_serializer_fields) ProjectSerializer Add a billing price estimate field to the serializer.
add_price_estimate Custom Signal (pre_serializer_fields) ProjectEstimatedCostPolicySerializer Add a billing price estimate field to the serializer.
add_price_estimate Custom Signal (pre_serializer_fields) CustomerSerializer Add a billing price estimate field to the serializer.
add_price_estimate Custom Signal (pre_serializer_fields) CustomerEstimatedCostPolicySerializer Add a billing price estimate field to the serializer.
add_project_credit Custom Signal (pre_serializer_fields) ProjectSerializer Add a project credit field to the serializer.
add_promotion_campaigns Custom Signal (pre_serializer_fields) PublicOfferingDetailsSerializer Add promotion campaigns to the serializer.
add_router_external_ips Custom Signal (pre_serializer_fields) OpenStackRouterSerializer Add router external IPs to the serializer.
add_service_provider Custom Signal (pre_serializer_fields) CustomerSerializer Add a service provider field to the serializer.
add_service_provider_url Custom Signal (pre_serializer_fields) CustomerSerializer Add a service provider URL field to the serializer.
add_service_provider_uuid Custom Signal (pre_serializer_fields) CustomerSerializer Add a service provider UUID field to the serializer.
apply_campaign_to_pending_invoices Django Signal (post_save) promotions.Campaign Apply campaign discounts to pending invoices and create discounted resources.
archive_offering Django Signal (pre_delete) openstack.Tenant Archive marketplace offerings when OpenStack tenant is deleted.
change_order_state Django Signal (post_save) waldur_azure.VirtualMachine Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) waldur_azure.SQLServer Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) waldur_azure.SQLDatabase Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) openstack.Instance Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) openstack.Volume Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) openstack.Tenant Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) waldur_rancher.Cluster Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) waldur_slurm.Allocation Change the state of an order based on resource state changes.
change_order_state Django Signal (post_save) waldur_vmware.VirtualMachine Change the state of an order based on resource state changes.
cleanup_admin_announcement_on_maintenance_deletion Django Signal (pre_delete) marketplace.MaintenanceAnnouncement Ensure AdminAnnouncement is cleaned up when MaintenanceAnnouncement is deleted.
close_customer_service_accounts_on_customer_deletion Django Signal (pre_delete) structure.Customer Close service accounts associated with a customer when the customer is deleted.
close_resource_plan_period_when_resource_is_terminated Django Signal (post_save) marketplace.Resource Handle case when resource has been terminated by service provider.
close_service_accounts_on_project_deletion Django Signal (pre_delete) structure.Project Close service accounts associated with a project when the project is deleted.
copy_invoice_item_from_openstack Django Signal (post_save) invoices.InvoiceItem No description
copy_invoice_items_when_cluster_is_provisioned Django Signal (post_save) marketplace.Resource Copy invoice items from parent project to provisioned Rancher cluster resource.
create_checklist_completion Django Signal (post_save) proposal.Proposal Create checklist completion tracking when proposal is created.
create_feedback_if_issue_has_been_resolved Django Signal (post_save) support.Issue Create feedback request when support issue transitions to resolved state.
create_issue_if_membership_changed Django Signal (post_save) permissions.UserRole Create support issue when user role membership changes in organization.
create_marketplace_resource_for_imported_cluster Custom Signal (resource_imported) waldur_rancher.Cluster Create marketplace resource when Rancher cluster is imported from external system.
create_marketplace_resource_for_imported_resources Custom Signal (resource_imported) waldur_azure.VirtualMachine No description
create_marketplace_resource_for_imported_resources Custom Signal (resource_imported) openstack.Instance No description
create_marketplace_resource_for_imported_resources Custom Signal (resource_imported) openstack.Volume No description
create_marketplace_resource_for_imported_resources Custom Signal (resource_imported) openstack.Tenant No description
create_offering_component_for_volume_type Django Signal (post_save) openstack.VolumeType Create marketplace offering component when OpenStack volume type is created.
create_offering_from_tenant Django Signal (post_save) openstack.Tenant No description
create_offering_user_checklist_completions Django Signal (post_save) marketplace.OfferingUser Create checklist completions for OfferingUser when created.
create_offering_user_for_new_resource Custom Signal (resource_creation_succeeded) marketplace.Resource Create an offering user for a new resource.
create_offering_user_for_rancher_user Django Signal (post_save) waldur_rancher.RancherUser No description
create_offering_user_for_slurm_user Custom Signal (slurm_association_created) waldur_slurm.Allocation No description
create_offering_users_when_project_role_granted Custom Signal (role_granted) — Create offering users when a project role is granted.
create_price_estimate Django Signal (post_save) structure.Project Create price estimate when customer or project is created.
create_price_estimate Django Signal (post_save) structure.Customer Create price estimate when customer or project is created.
create_public_cluster_ip_for_floating_ip Django Signal (post_save) openstack.FloatingIP No description
create_recurring_usage_if_invoice_has_been_created Django Signal (post_save) invoices.Invoice No description
create_request_when_project_is_updated Django Signal (post_save) structure.Project No description
create_resource_of_volume_if_instance_created Django Signal (post_save) marketplace.Resource No description
create_resource_plan_period_when_resource_is_created Django Signal (post_save) marketplace.Resource Create a resource plan period when a resource is created.
create_screenshot_thumbnail Django Signal (post_save) marketplace.Screenshot Create a thumbnail for a screenshot.
customer_credit_changed_handler Django Signal (post_save) invoices.CustomerCredit Handle customer credit value changes and evaluate related policies.
customer_credit_offerings_list_changed_handler Django Signal (m2m_changed) CustomerCredit_offerings No description
customer_estimated_cost_policy_trigger_handler Django Signal (post_save) invoices.InvoiceItem Evaluate customer cost policies when invoice items are updated.
delete_checklist_completion Django Signal (pre_delete) proposal.Proposal Remove checklist completion tracking when proposal is deleted.
delete_expired_project_if_every_resource_has_been_terminated Django Signal (post_save) marketplace.Resource Delete an expired project if all its resources have been terminated.
delete_offering_component_for_volume_type Django Signal (post_delete) openstack.VolumeType No description
delete_offering_user_checklist_completions Django Signal (pre_delete) marketplace.OfferingUser Delete related checklist completions when OfferingUser is deleted.
delete_remote_project Django Signal (post_delete) structure.Project No description
delete_service_setting_when_offering_is_deleted Django Signal (post_delete) marketplace.Offering Delete service settings when an offering is deleted.
delete_stale_price_estimate Django Signal (pre_delete) structure.Project Delete price estimates when customer or project is deleted.
delete_stale_price_estimate Django Signal (pre_delete) structure.Customer Delete price estimates when customer or project is deleted.
disable_archived_service_settings_without_existing_resource Django Signal (post_save) marketplace.Resource Disable archived service settings if there are no existing resources.
disable_service_settings_without_existing_resource_when_archived Django Signal (post_save) marketplace.Offering Disable service settings without existing resources when an offering is archived.
drop_offering_user_for_rancher_user Django Signal (pre_delete) waldur_rancher.RancherUser No description
drop_offering_user_for_slurm_user Custom Signal (slurm_association_deleted) waldur_slurm.Allocation No description
emit_invoice_created_event Django Signal (post_save) invoices.Invoice Emit invoice created signal when invoice state changes to CREATED.
enable_service_settings_when_not_archived Django Signal (post_save) marketplace.Offering Enable service settings when an offering is not archived.
enable_service_settings_with_existing_resource Django Signal (post_save) marketplace.Resource Enable service settings if there are existing resources.
handle_openstack_tenant_order_creation Django Signal (post_save) marketplace.Order No description
handle_openstack_tenant_order_termination Django Signal (post_save) marketplace.Order No description
handler Django Signal (post_save) marketplace.Resource No description
handler Django Signal (post_save) invoices.InvoiceItem No description
handler Django Signal (post_save) marketplace.ComponentUsage No description
import_instances_and_volumes_if_tenant_has_been_imported Custom Signal (resource_imported) openstack.Tenant No description
import_instances_and_volumes_if_tenant_has_been_imported Custom Signal (tenant_pull_succeeded) openstack.Tenant No description
import_resource_metadata_when_resource_is_created Django Signal (post_save) marketplace.Resource Import OpenStack resource metadata when marketplace resource is created.
init_resource_parent Django Signal (post_save) marketplace.Resource Initialize the parent resource for a newly created resource.
limit_update_failed Custom Signal (resource_limit_update_failed) marketplace.Resource Handle failed limit updates.
limit_update_succeeded Custom Signal (resource_limit_update_succeeded) marketplace.Resource Handle successful limit updates.
log_attachment_delete Django Signal (post_delete) support.Attachment No description
log_attachment_save Django Signal (post_save) support.Attachment No description
log_credit Django Signal (post_save) invoices.CustomerCredit No description
log_invoice_item_delete Django Signal (post_delete) invoices.InvoiceItem No description
log_invoice_item_save Django Signal (post_save) invoices.InvoiceItem No description
log_invoice_state_transition Django Signal (post_save) invoices.Invoice No description
log_issue_delete Django Signal (post_delete) support.Issue No description
log_issue_save Django Signal (post_save) support.Issue No description
log_offering_role_created_or_updated Django Signal (post_save) marketplace.OfferingUserRole Log offering role creation and updates.
log_offering_role_deleted Django Signal (post_delete) marketplace.OfferingUserRole Log offering role deletion.
log_offering_user_created Django Signal (post_save) marketplace.OfferingUser Log offering user creation.
log_offering_user_deleted Django Signal (post_delete) marketplace.OfferingUser Log offering user deletion.
log_order_events Django Signal (post_save) marketplace.Order Log order creation and state transition events.
log_request_events Django Signal (post_save) marketplace_remote.ProjectUpdateRequest No description
log_resource_events Django Signal (post_save) marketplace.Resource Log resource creation request events.
log_resource_robot_account_created_or_updated Django Signal (post_save) marketplace.RobotAccount Log resource robot account creation and updates.
log_resource_robot_account_deleted Django Signal (post_delete) marketplace.RobotAccount Log resource robot account deletion.
log_resource_user_created Django Signal (post_save) marketplace.ResourceUser Log resource user creation.
log_resource_user_deleted Django Signal (post_delete) marketplace.ResourceUser Log resource user deletion.
log_service_account_created_or_updated Django Signal (post_save) ScopedServiceAccount Log service account creation and updates.
log_service_account_deleted Django Signal (post_delete) ScopedServiceAccount Log service account deletion.
manage_maintenance_admin_announcements Django Signal (post_save) marketplace.MaintenanceAnnouncement Manage AdminAnnouncement lifecycle based on MaintenanceAnnouncement state changes.
mark_synced_fields_as_read_only Custom Signal (pre_serializer_fields) OfferingOptionsUpdateSerializer No description
mark_synced_fields_as_read_only Custom Signal (pre_serializer_fields) OfferingOverviewUpdateSerializer No description
notify_about_project_details_update Django Signal (post_save) marketplace_remote.ProjectUpdateRequest No description
notify_about_request_based_item_creation Django Signal (post_save) support.Issue No description
notify_approvers_when_order_is_created Django Signal (post_save) marketplace.Order Notify approvers when an order is created.
notify_user_about_rejected_order Django Signal (post_save) marketplace.Order Notify user about rejected order.
offering_component_has_been_created_or_updated Django Signal (post_save) marketplace.OfferingComponent Log offering component creation and updates.
offering_component_has_been_deleted Django Signal (post_delete) marketplace.OfferingComponent Log offering component deletion.
offering_has_been_created_or_updated Django Signal (post_save) marketplace.Offering Log offering creation and state updates.
on_resource_post_save Django Signal (post_save) marketplace.Resource Handle resource state changes and billing events.
plan_component_has_been_updated Django Signal (post_save) marketplace.PlanComponent Log plan component updates.
plan_has_been_created_or_updated Django Signal (post_save) marketplace.Plan Log plan creation, update, and archiving events.
process_invitations_and_orders_when_project_start_date_is_unset Django Signal (post_save) structure.Project Process pending invitations and orders when a project's start date is unset.
process_invoice_item Django Signal (post_save) invoices.InvoiceItem Process invoice item changes and update related price estimates.
project_credit_changed_handler Django Signal (post_save) invoices.ProjectCredit No description
project_estimated_cost_policy_trigger_handler Django Signal (post_save) invoices.InvoiceItem Evaluate project cost policies when invoice items are updated.
resource_has_been_changed Django Signal (post_save) marketplace.Resource Log resource changes.
resource_options_have_been_changed Django Signal (post_save) marketplace.Resource Handle script execution when marketplace resource options are changed.
resource_state_has_been_changed Django Signal (post_save) marketplace.Resource Handle resource state changes.
run_reset_actions_upon_cost_policy_deletion Django Signal (pre_delete) policy.ProjectEstimatedCostPolicy Execute reset actions when a cost policy is deleted.
send_comment_added_notification Django Signal (post_save) support.Comment No description
send_done_order_to_message_queue Django Signal (post_save) marketplace.Order Send completed marketplace order to message queue for site agent processing.
send_issue_updated_notification Django Signal (post_save) support.Issue No description
send_offering_user_username_message Django Signal (post_save) marketplace.OfferingUser No description
send_pending_order_to_message_queue Django Signal (post_save) marketplace.Order Send pending marketplace order to message queue for site agent processing.
send_project_service_account_deletion_info Django Signal (post_save) marketplace.ProjectServiceAccount No description
send_project_service_account_info Django Signal (post_save) marketplace.ProjectServiceAccount No description
send_resource_update_message_to_queue Django Signal (post_save) marketplace.Resource No description
send_role_granted_message_to_queue Custom Signal (role_granted) — No description
send_role_revoked_message_to_queue Custom Signal (role_revoked) — No description
set_mtu_when_network_has_been_created Django Signal (post_save) openstack.Network No description
set_project_name_on_invoice_item_creation Django Signal (post_save) invoices.InvoiceItem No description
set_tax_percent_on_invoice_creation Django Signal (pre_save) invoices.Invoice No description
switch_resource_plan_period_when_plan_is_updated Django Signal (post_save) marketplace.Resource Switch the resource plan period when a resource's plan is updated.
sync_component_user_usage_when_allocation_user_usage_is_submitted Django Signal (post_save) waldur_slurm.AllocationUserUsage No description
sync_limits Django Signal (post_save) marketplace.Resource Synchronize resource limits.
sync_permission_with_remote Custom Signal (role_granted) — No description
sync_permission_with_remote Custom Signal (role_revoked) — No description
sync_permission_with_remote Custom Signal (role_updated) — No description
sync_remote_project_when_request_is_approved Django Signal (post_save) marketplace_remote.ProjectUpdateRequest No description
sync_resource_limit_when_order Django Signal (post_save) marketplace.Order Synchronize resource limits when an order is created.
synchronize_directly_connected_ips Django Signal (post_save) openstack.Instance No description
synchronize_floating_ips Django Signal (post_save) openstack.FloatingIP No description
synchronize_floating_ips_on_delete Django Signal (post_delete) openstack.FloatingIP No description
synchronize_instance_after_pull Django Signal (post_save) openstack.Instance No description
synchronize_instance_hypervisor_hostname Django Signal (post_save) openstack.Instance No description
synchronize_instance_name Django Signal (post_save) openstack.Instance No description
synchronize_limits_when_storage_mode_is_switched Django Signal (post_save) marketplace.Offering No description
synchronize_nic Django Signal (post_save) waldur_azure.NetworkInterface No description
synchronize_ports Django Signal (post_save) openstack.Port No description
synchronize_ports_on_delete Django Signal (post_delete) openstack.Port No description
synchronize_public_ip Django Signal (post_save) waldur_azure.PublicIP No description
synchronize_resource_metadata_on_delete Django Signal (post_delete) waldur_azure.VirtualMachine Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) waldur_azure.SQLServer Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) waldur_azure.SQLDatabase Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) openstack.Instance Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) openstack.Volume Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) openstack.Tenant Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) waldur_rancher.Cluster Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) waldur_slurm.Allocation Synchronize resource metadata on delete.
synchronize_resource_metadata_on_delete Django Signal (post_delete) waldur_vmware.VirtualMachine Synchronize resource metadata on delete.
synchronize_resource_metadata_on_save Django Signal (post_save) waldur_azure.VirtualMachine Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) waldur_azure.SQLServer Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) waldur_azure.SQLDatabase Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) openstack.Instance Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) openstack.Volume Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) openstack.Tenant Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) waldur_rancher.Cluster Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) waldur_slurm.Allocation Synchronize resource metadata on save.
synchronize_resource_metadata_on_save Django Signal (post_save) waldur_vmware.VirtualMachine Synchronize resource metadata on save.
synchronize_router_backend_metadata Django Signal (post_save) openstack.Router No description
synchronize_tenant_name Django Signal (post_save) openstack.Tenant No description
synchronize_volume_metadata_on_pull Custom Signal (resource_pulled) openstack.Volume No description
synchronize_volume_metadata_on_save Django Signal (post_save) openstack.Volume No description
tenant_does_not_exist_in_backend Custom Signal (tenant_does_not_exist_in_backend) openstack.Tenant No description
terminate_resource Django Signal (pre_delete) waldur_azure.VirtualMachine Terminate a resource.
terminate_resource Django Signal (pre_delete) waldur_azure.SQLServer Terminate a resource.
terminate_resource Django Signal (pre_delete) waldur_azure.SQLDatabase Terminate a resource.
terminate_resource Django Signal (pre_delete) openstack.Instance Terminate a resource.
terminate_resource Django Signal (pre_delete) openstack.Volume Terminate a resource.
terminate_resource Django Signal (pre_delete) openstack.Tenant Terminate a resource.
terminate_resource Django Signal (pre_delete) waldur_rancher.Cluster Terminate a resource.
terminate_resource Django Signal (pre_delete) waldur_slurm.Allocation Terminate a resource.
terminate_resource Django Signal (pre_delete) waldur_vmware.VirtualMachine Terminate a resource.
trigger_order_callback Django Signal (post_save) marketplace.Order Trigger HTTP callback when marketplace order state changes.
update_argocd_secret_when_resource_options_changed Django Signal (post_save) marketplace.Resource No description
update_cache_when_invoice_item_is_deleted Django Signal (post_delete) invoices.InvoiceItem No description
update_cache_when_invoice_item_is_updated Django Signal (post_save) invoices.InvoiceItem No description
update_category_offerings_count Custom Signal (recalculate_quotas) — Update the count of offerings for each category.
update_category_quota_when_offering_is_created Django Signal (post_save) marketplace.Offering Update category quota when an offering is created or its state changes.
update_category_quota_when_offering_is_deleted Django Signal (post_delete) marketplace.Offering Update category quota when an offering is deleted.
update_component_quota Django Signal (post_save) waldur_slurm.Allocation No description
update_customer_of_offering_if_project_has_been_moved Custom Signal (project_moved) structure.Project Update the customer of an offering if the project has been moved.
update_daily_quotas Django Signal (post_save) quotas.QuotaUsage No description
update_estimate_when_invoice_is_created Django Signal (post_save) invoices.Invoice Update price estimates when new invoice is created for customer.
update_floating_ip_external_addresses Django Signal (post_save) openstack.FloatingIP No description
update_google_calendar_name_if_offering_name_has_been_changed Django Signal (post_save) marketplace.Offering No description
update_instances_ip_external_addresses Django Signal (post_save) marketplace.Offering No description
update_invoice_item_on_project_name_update Django Signal (post_save) structure.Project No description
update_invoice_when_usage_is_reported Django Signal (post_save) marketplace.ComponentUsage Handle usage-based billing when component usage is reported.
update_maintenance_announcement_on_offering_change Django Signal (post_save) marketplace.MaintenanceAnnouncementOffering Update AdminAnnouncement when affected offerings change.
update_maintenance_announcement_on_offering_change Django Signal (post_delete) marketplace.MaintenanceAnnouncementOffering Update AdminAnnouncement when affected offerings change.
update_marketplace_resource_limits_when_vm_is_updated Custom Signal (vm_updated) — No description
update_offering_user_username_after_freeipa_profile_update Django Signal (post_save) waldur_freeipa.Profile Update offering user usernames after FreeIPA profile update.
update_offering_user_username_after_offering_settings_change Django Signal (post_save) marketplace.Offering Update offering user usernames after offering settings change.
update_offering_user_username_after_user_change Django Signal (post_save) core.User Set new username for offering users after site_username in user details has been changed.
update_openstack_tenant_usages Django Signal (post_save) quotas.QuotaUsage No description
update_order_if_issue_was_complete Django Signal (post_save) support.Issue No description
update_remote_resource_options Django Signal (post_save) marketplace.Resource No description
update_resource_when_order_is_rejected_or_erred Django Signal (post_save) marketplace.Order Update resource state when an order is rejected or erred.

Application: waldur_openstack

Handler Name Signal Type Sender Description
add_instance_fields Custom Signal (pre_serializer_fields) OpenStackFloatingIPSerializer Add instance-related fields to the serializer.
delete_state_service_properties Django Signal (post_delete) openstack.Tenant Delete state service properties.
log_action Django Signal (post_save) openstack.Instance Log any resource action.
log_action Django Signal (post_save) openstack.Volume Log any resource action.
log_action Django Signal (post_save) openstack.Snapshot Log any resource action.
log_network_cleaned Django Signal (post_delete) openstack.Network Log network cleanup.
log_security_group_cleaned Django Signal (post_delete) openstack.SecurityGroup Log security group cleanup.
log_security_group_rule_cleaned Django Signal (post_delete) openstack.SecurityGroupRule Log security group rule cleanup.
log_server_group_cleaned Django Signal (post_delete) openstack.ServerGroup Log server group cleanup.
log_subnet_cleaned Django Signal (post_delete) openstack.SubNet Log subnet cleanup.
log_tenant_quota_update Django Signal (post_save) quotas.QuotaLimit Log tenant quota updates.
remove_ssh_key_from_all_tenants_on_it_deletion Django Signal (pre_delete) core.SshPublicKey Delete key from all tenants that are accessible for user on key deletion.
remove_ssh_key_from_tenants Custom Signal (role_revoked) — Delete user ssh keys from tenants that he does not have access now.

Application: waldur_openstack_replication

Handler Name Signal Type Sender Description
handle_migration_post_save Django Signal (post_save) waldur_openstack_replication.Migration Handle migration post-save events.

Application: waldur_rancher

Handler Name Signal Type Sender Description
add_group_to_rancher_scope Django Signal (post_save) waldur_rancher.KeycloakGroup Add a Keycloak group to Rancher scope.
add_rancher_cluster_to_openstack_instance Custom Signal (pre_serializer_fields) OpenStackInstanceSerializer Add Rancher cluster information to OpenStack instance serializer.
delete_catalog_if_scope_has_been_deleted Django Signal (post_delete) waldur_rancher.Project Delete a catalog if its scope has been deleted.
delete_catalog_if_scope_has_been_deleted Django Signal (post_delete) waldur_rancher.Cluster Delete a catalog if its scope has been deleted.
delete_catalog_if_scope_has_been_deleted Django Signal (post_delete) structure.ServiceSettings Delete a catalog if its scope has been deleted.
delete_cluster_if_all_related_nodes_have_been_deleted Django Signal (post_delete) waldur_rancher.Node Delete a Rancher cluster if all its related nodes have been deleted.
delete_keycloak_group_from_backend Django Signal (post_delete) waldur_rancher.KeycloakGroup Delete a Keycloak group from the backend.
delete_keycloak_user_group_membership_from_backend Django Signal (post_delete) waldur_rancher.KeycloakUserGroupMembership Delete a Keycloak user group membership from the backend.
delete_node_if_related_instance_has_been_deleted Django Signal (post_delete) openstack.Instance Delete a Rancher node if its related OpenStack instance has been deleted.
remove_group_from_rancher_scope Django Signal (post_delete) waldur_rancher.KeycloakGroup Remove a Keycloak group from Rancher scope.
set_error_state_for_cluster_if_related_node_deleting_is_failed Django Signal (post_save) waldur_rancher.Node Set error state for a Rancher cluster if a related node deletion fails.
set_error_state_for_node_if_related_instance_deleting_is_failed Django Signal (post_save) openstack.Instance Set error state for a Rancher node if its related OpenStack instance deletion fails.

Application: waldur_slurm

Handler Name Signal Type Sender Description
process_role_granted Custom Signal (role_granted) — Process role granted events for FreeIPA synchronization.
process_role_revoked Custom Signal (role_revoked) — Process role revoked events for FreeIPA synchronization.
process_user_creation Django Signal (post_save) waldur_freeipa.Profile Process user creation for FreeIPA profiles.
process_user_deletion Django Signal (pre_delete) waldur_freeipa.Profile Process user deletion for FreeIPA profiles.
update_quotas_on_allocation_usage_update Django Signal (post_save) waldur_slurm.Allocation Update quotas on allocation usage update.

Application: waldur_vmware

Handler Name Signal Type Sender Description
update_vm_total_disk_when_disk_is_created_or_updated Django Signal (post_save) waldur_vmware.Disk Update VM total disk size when a disk is created or updated.
update_vm_total_disk_when_disk_is_deleted Django Signal (post_delete) waldur_vmware.Disk Update VM total disk size when a disk is deleted.

Summary

Total unique handlers found: 633

  • waldur_auth_saml2: 1 handlers
  • waldur_autoprovisioning: 1 handlers
  • waldur_core: 333 handlers
  • waldur_freeipa: 12 handlers
  • waldur_lexis: 1 handlers
  • waldur_mastermind: 252 handlers
  • waldur_openstack: 13 handlers
  • waldur_openstack_replication: 1 handlers
  • waldur_rancher: 12 handlers
  • waldur_slurm: 5 handlers
  • waldur_vmware: 2 handlers

HomePort requirements

Overview

Homeport is a React-based application for interacting with Waldur Mastermind via browsers. It is intended for end-users as well as administrative roles.

Mobile-friendliness

All Homeport screens should be usable with mobile resolution.

Resource details
Resource details (desktop)
Resource details, mobile
Resource details (mobile)

Localization

All labels should be wrapped by translation tags to allow easy translations.

For details see instructions for developers.

Accessibility and WCAG compliance

Homeport is being used by human end-users and hence is developed according to the WCAG guidelines.

In particular, the following is followed:

  1. Static and dynamic linters for assuring that generated user interface conforms to technical requirements of WCAG (anchors, required attributes, etc).
  2. Usage of WCAG compliant colors in UI theme, provisioning of dark and light modes.
  3. Navigation is designed to be in compliance with WCAG 2.0 requirements.
  4. Manual testing for WCAG violations.

Internationalization

Per-request internationalization is enabled by default for English and Estonian languages. Client requests will respect the Accept-Language.

Here are the guidelines for specifying translation strings:

  • Build a proper sentence: start with a capital letter, end with a period.

Right: _('Deletion was scheduled.')

Wrong: _('deletion was scheduled')

  • Use named-string interpolation instead of positional interpolation if message has several parameters.

Right: _('Operation was successfully scheduled for %(count)d instances: %(names)s.')

Wrong: _('Operation was successfully scheduled for %s instances: %s.')

  • help_text, verbose_name, exception message and response message should be marked, but don't mark message template for event or alert logger.

Installation Guide

Installation via Dev Containers

If you use VS Code or GitHub Codespaces, you can quickly set up a development environment using Dev Containers. This method provides a consistent, pre-configured environment with all necessary dependencies.

Prerequisites for Dev Containers are:

After cloning repository, when prompted "Reopen in Container", click on it. Alternatively, you can press Ctrl+Shift+P, type "Dev Containers: Reopen in Container" and press Enter.

VS Code will build the dev container and set up the environment automatically. This process includes:

  • Installing all system dependencies
  • Setting up Python with the correct version
  • Installing VS Code extensions
  • Installing uv and project dependencies
  • Installing PostgreSQL
  • Configuring pre-commit hooks

Once the container is built and running, you'll have a fully configured development environment ready to use.

Installation from source

Prerequisites

  • Linux OS. If you use Windows, you should install Linux either via Virtualbox or Windows Subsystem for Linux.
  • git
  • virtualenv
  • C compiler and development libraries needed to build dependencies

Package installation by OS

  • Debian or Ubuntu: sudo apt install git python3-pip python3-venv python3-dev gcc libffi-dev libsasl2-dev libssl-dev libpq-dev libjpeg8-dev zlib1g-dev xmlsec1 libldap2-dev liblzma-dev libxslt1-dev libxml2-dev libbz2-dev libreadline-dev libsqlite3-dev

  • OS X: brew install openssl; export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"; export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"

Installation steps

Install uv

1
curl -LsSf https://astral.sh/uv/install.sh | sh

Install pyenv

1
2
3
curl https://pyenv.run | bash
pyenv install 3.11.9
pyenv global 3.11.9

Get the code

1
2
git clone https://github.com/waldur/waldur-mastermind.git
cd waldur-mastermind

Install Waldur in development mode

1
2
3
uv sync --dev
uv pip install -e .
uv run pre-commit install

NB: If you use a machine with Apple M1 CPU, run this before:

1
2
3
4
export optflags="-Wno-error=implicit-function-declaration"
export LDFLAGS="-L/opt/homebrew/opt/libffi/lib"
export CPPFLAGS="-I/opt/homebrew/opt/libffi/include"
export PKG_CONFIG_PATH="/opt/homebrew/opt/libffi/lib/pkgconfig"

Create and edit settings file

1
2
cp src/waldur_core/server/settings.py.example src/waldur_core/server/settings.py
vi src/waldur_core/server/settings.py

Database setup

Initialize PostgreSQL database:

1
2
3
sudo -u postgres -i
createdb waldur
createuser waldur

Add a password waldur for this user:

1
2
3
psql
ALTER USER waldur PASSWORD 'waldur';
ALTER DATABASE waldur OWNER TO waldur;

Final Setup Steps

Run migrations:

1
uv run waldur migrate --noinput

Collect static files:

1
uv run waldur collectstatic --noinput

Start Waldur:

1
uv run waldur runserver

Additional configuration

For detailed configuration instructions, visit https://docs.waldur.com/latest/admin-guide/mastermind-configuration/general/

Maintenance Announcement Management

Overview

The MaintenanceAnnouncement system provides a comprehensive solution for managing and communicating maintenance activities across Waldur services. Service providers can create, schedule, execute, and track maintenance announcements through a complete REST API interface. The system automatically integrates with the AdminAnnouncement system to provide user-facing notifications when maintenance is scheduled.

Core Concepts

MaintenanceAnnouncement Model

Maintenance announcements represent planned or emergency maintenance activities that may affect service availability. Each announcement includes:

  • Basic Information: Name, message, maintenance type
  • External Integration: Optional reference URL to external maintenance trackers
  • Scheduling: Planned start/end times, actual start/end times
  • State Management: FSM-controlled lifecycle states
  • Service Provider: Associated service provider responsible for the maintenance
  • Impact Tracking: Affected offerings with specific impact levels
  • AdminAnnouncement Integration: Automatic creation of user-facing notifications when scheduled

State Lifecycle

MaintenanceAnnouncement follows a finite state machine (FSM) with the following states:

1
2
3
DRAFT → SCHEDULED ← (unschedule)
  ↓         ↓
CANCELLED   IN_PROGRESS → COMPLETED

State Descriptions:

  • DRAFT: Initial state when maintenance is created but not yet published
  • SCHEDULED: Published maintenance announcement visible to customers
  • IN_PROGRESS: Maintenance is actively being performed
  • COMPLETED: Maintenance has finished successfully
  • CANCELLED: Maintenance was cancelled before completion

REST API Operations

Standard CRUD Operations

List Maintenance Announcements

1
GET /api/maintenance-announcements/

Create Maintenance Announcement

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
POST /api/maintenance-announcements/
Content-Type: application/json

{
  "name": "Database Server Upgrade",
  "message": "We will be upgrading our database servers to improve performance...",
  "maintenance_type": 4,
  "external_reference_url": "https://maintenance.example.com/ticket/12345",
  "scheduled_start": "2024-01-15T02:00:00Z",
  "scheduled_end": "2024-01-15T04:00:00Z",
  "service_provider": "http://localhost:8000/api/service-providers/{uuid}/"
}

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "url": "http://localhost:8000/api/maintenance-announcements/{uuid}/",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Database Server Upgrade",
  "message": "We will be upgrading our database servers to improve performance...",
  "maintenance_type": 4,
  "external_reference_url": "https://maintenance.example.com/ticket/12345",
  "scheduled_start": "2024-01-15T02:00:00Z",
  "scheduled_end": "2024-01-15T04:00:00Z",
  "service_provider": "http://localhost:8000/api/service-providers/{uuid}/",
  "affected_offerings": [],
  "state": "Draft",
  "created": "2024-01-01T10:00:00Z",
  "modified": "2024-01-01T10:00:00Z"
}

Retrieve Maintenance Announcement

1
GET /api/maintenance-announcements/{uuid}/

Update Maintenance Announcement

1
2
3
4
5
6
7
PATCH /api/maintenance-announcements/{uuid}/
Content-Type: application/json

{
  "message": "Updated maintenance details...",
  "external_reference_url": "https://servicedesk.company.com/ticket/MAINT-67890"
}

Delete Maintenance Announcement

1
DELETE /api/maintenance-announcements/{uuid}/

State Management Actions

All state management actions use POST method and follow the same pattern:

Schedule Maintenance

Publishes a draft maintenance announcement, making it visible to customers and automatically creates an associated AdminAnnouncement for user notifications.

1
POST /api/maintenance-announcements/{uuid}/schedule/

Requirements:

  • Current state must be DRAFT
  • User must be staff or service provider owner

Result:

  • State transition: DRAFT → SCHEDULED
  • AdminAnnouncement creation: Automatically creates a user-facing notification
  • Content generation: Uses maintenance type prefix + message
  • Priority mapping: Sets appropriate priority based on maintenance type
  • Timing: Active from scheduled_start - notify_before_minutes to scheduled_end + 1 hour

Unschedule Maintenance

Unpublishes a scheduled maintenance announcement, returning it to draft state and removes the associated AdminAnnouncement.

1
POST /api/maintenance-announcements/{uuid}/unschedule/

Requirements:

  • Current state must be SCHEDULED
  • User must be staff or service provider owner

Result:

  • State transition: SCHEDULED → DRAFT
  • AdminAnnouncement cleanup: Automatically deletes the associated user notification

Start Maintenance

Marks maintenance as actively in progress.

1
POST /api/maintenance-announcements/{uuid}/start_maintenance/

Requirements:

  • Current state must be SCHEDULED
  • User must be staff or service provider owner
  • Automatically sets actual_start timestamp

Result: SCHEDULED → IN_PROGRESS

Complete Maintenance

Marks maintenance as successfully completed.

1
POST /api/maintenance-announcements/{uuid}/complete_maintenance/

Requirements:

  • Current state must be IN_PROGRESS
  • User must be staff or service provider owner
  • Automatically sets actual_end timestamp

Result: IN_PROGRESS → COMPLETED

Cancel Maintenance

Cancels maintenance before completion and removes any associated AdminAnnouncement.

1
POST /api/maintenance-announcements/{uuid}/cancel_maintenance/

Requirements:

  • Current state must be DRAFT or SCHEDULED
  • User must be staff or service provider owner

Result:

  • State transition: DRAFT|SCHEDULED → CANCELLED
  • AdminAnnouncement cleanup: Automatically deletes the associated user notification (if scheduled)

Response Format

Success Response (200 OK):

1
2
3
{
  "detail": "Maintenance announcement has been [action]"
}

State Validation Error (409 Conflict):

1
2
3
{
  "detail": "Invalid state transition"
}

Permission Error (404 Not Found):

1
2
3
{
  "detail": "Not found."
}

Authentication Error (401 Unauthorized):

1
2
3
{
  "detail": "Authentication credentials were not provided."
}

Maintenance Types

The system supports different types of maintenance activities:

Value Type Description
1 Scheduled Planned maintenance during scheduled windows
2 Emergency Unplanned maintenance for critical issues
3 Security Security-related updates and patches
4 Upgrade System upgrades and feature deployments
5 Patch Minor patches and bug fixes

AdminAnnouncement Integration

Automatic User Notifications

When a MaintenanceAnnouncement transitions from DRAFT to SCHEDULED state, the system automatically creates an associated AdminAnnouncement to notify users. This integration provides:

Content Generation

The AdminAnnouncement content is automatically generated with:

  • Type-specific prefix: Each maintenance type gets a descriptive emoji prefix
  • 🔧 Scheduled Maintenance
  • 🚨 Emergency Maintenance
  • 🔒 Security Maintenance
  • ⬆️ System Upgrade
  • 🩹 Patch Deployment
  • Original message: The maintenance message is used as-is
  • Combined format: [Type Prefix]: [Original Message]

Example:

1
2
MaintenanceAnnouncement message: "Database servers will be upgraded for improved performance"
AdminAnnouncement content: "🔧 Scheduled Maintenance: Database servers will be upgraded for improved performance"

Priority Mapping

AdminAnnouncement priority is automatically set based on maintenance type:

  • Emergency maintenance → DANGER priority (red alerts)
  • Security maintenance → WARNING priority (yellow alerts)
  • All other types → INFORMATION priority (blue alerts)

Timing Configuration

AdminAnnouncements are scheduled using the MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES setting:

  • Active from: scheduled_start - notify_before_minutes
  • Active to: scheduled_end + 1 hour (buffer for completion)

Default notify_before_minutes is 60 minutes.

Lifecycle Management

The AdminAnnouncement automatically syncs with MaintenanceAnnouncement changes:

  • Content updates: When maintenance message or type changes
  • Cleanup: When maintenance is unscheduled or cancelled
  • Deletion handling: Uses SET_NULL to handle manual AdminAnnouncement deletions

Enhanced AdminAnnouncement API

When a MaintenanceAnnouncement is scheduled, the associated AdminAnnouncement exposes additional maintenance-related fields through the API:

Additional Serializer Fields

1
GET /api/admin-announcements/{uuid}/

Response includes maintenance fields:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "uuid": "admin-announcement-uuid",
  "description": "🔧 Scheduled Maintenance: Database servers will be upgraded",
  "type": 1,
  "active_from": "2024-01-15T01:00:00Z",
  "active_to": "2024-01-15T05:00:00Z",
  "maintenance_uuid": "maintenance-announcement-uuid",
  "maintenance_name": "Database Server Upgrade",
  "maintenance_type": "upgrade",
  "maintenance_state": "scheduled",
  "maintenance_scheduled_start": "2024-01-15T02:00:00Z",
  "maintenance_scheduled_end": "2024-01-15T04:00:00Z",
  "maintenance_service_provider": "Example Cloud Services",
  "maintenance_affected_offerings": [
    {
      "uuid": "offering-uuid-1",
      "name": "Database Service",
      "impact_level": "partial_outage",
      "impact_level_display": "Partial outage",
      "impact_description": "Database connections may be intermittent"
    },
    {
      "uuid": "offering-uuid-2",
      "name": "API Gateway",
      "impact_level": "degraded_performance",
      "impact_level_display": "Degraded performance",
      "impact_description": "API responses may be slower than usual"
    }
  ]
}

Field Descriptions:

  • maintenance_uuid: UUID of the associated MaintenanceAnnouncement
  • maintenance_name: Human-readable name of the maintenance
  • maintenance_type: Type of maintenance (upgrade, emergency, etc.)
  • maintenance_state: Current FSM state of the maintenance
  • maintenance_scheduled_start/end: Planned maintenance window
  • maintenance_service_provider: Name of the responsible service provider
  • maintenance_affected_offerings: Array of affected offerings with impact details

API Integration Notes

  • Conditional fields: Maintenance fields are only present when AdminAnnouncement has an associated MaintenanceAnnouncement
  • Real-time updates: Fields automatically update when maintenance details change
  • OpenAPI documentation: All fields are properly documented with type hints for schema generation
  • Null safety: Fields return null or empty arrays when no maintenance is associated

Configuration

Settings

MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES

Controls how long before the scheduled maintenance start time that AdminAnnouncements become active.

Default: 60 (minutes)

Usage:

1
2
3
4
# settings.py
CONSTANCE_CONFIG = {
    'MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES': (60, 'Minutes before maintenance to show admin announcements'),
}

Effect:

  • AdminAnnouncement active_from = maintenance.scheduled_start - notify_before_minutes
  • Users see the notification from this time until maintenance completion + 1 hour buffer

External Integration

External Reference URL

The external_reference_url field provides integration with external maintenance tracking systems. This optional field allows you to:

  • Link to external tickets: Connect maintenance announcements to tickets in systems like ServiceNow, JIRA, or custom trackers
  • Provide additional context: Reference external documentation, status pages, or monitoring dashboards
  • Enable workflow integration: Allow teams to track maintenance across multiple systems

Usage Examples:

  • https://servicedesk.company.com/ticket/MAINT-12345
  • https://status.example.com/incidents/2024-01-15-database-upgrade
  • https://monitoring.company.com/dashboard/maintenance/db-upgrade-2024

API Field Details:

  • Type: URL field (validates URL format)
  • Required: No (blank=True)
  • Use Cases: External ticket references, status page links, monitoring dashboards

Impact Levels

Each affected offering can specify its expected impact level:

Value Level Description
1 No Impact Service remains fully operational
2 Degraded Performance Service available but with reduced performance
3 Partial Outage Some features unavailable
4 Full Outage Service completely unavailable

Managing Affected Offerings

Maintenance announcements can specify which offerings will be affected through a separate endpoint. The affected_offerings field in the MaintenanceAnnouncement response is read-only and populated from associated MaintenanceAnnouncementOffering records.

Affected Offerings Workflow

  1. Create the maintenance announcement (as shown above)
  2. Add affected offerings using the separate endpoint
  3. The affected_offerings field will automatically reflect the associations

Affected Offerings API

List Affected Offerings

1
GET /api/maintenance-announcement-offerings/

Create Affected Offering

1
2
3
4
5
6
7
8
9
POST /api/maintenance-announcement-offerings/
Content-Type: application/json

{
  "maintenance": "http://localhost:8000/api/maintenance-announcements/{uuid}/",
  "offering": "http://localhost:8000/api/marketplace-offerings/{uuid}/",
  "impact_level": 3,
  "impact_description": "API endpoints will be unavailable during database migration"
}

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "url": "http://localhost:8000/api/maintenance-announcement-offerings/{uuid}/",
  "uuid": "550e8400-e29b-41d4-a716-446655440001",
  "maintenance": "http://localhost:8000/api/maintenance-announcements/{uuid}/",
  "offering": "http://localhost:8000/api/marketplace-offerings/{uuid}/",
  "impact_level": 3,
  "impact_level_display": "Partial outage",
  "impact_description": "API endpoints will be unavailable during database migration",
  "offering_name": "My Service API"
}

Retrieve Affected Offering

1
GET /api/maintenance-announcement-offerings/{uuid}/

Update Affected Offering

1
2
3
4
5
6
7
PATCH /api/maintenance-announcement-offerings/{uuid}/
Content-Type: application/json

{
  "impact_level": 2,
  "impact_description": "Minor performance degradation expected"
}

Delete Affected Offering

1
DELETE /api/maintenance-announcement-offerings/{uuid}/

Viewing Affected Offerings

Once affected offerings are added, they appear in the MaintenanceAnnouncement response:

1
GET /api/maintenance-announcements/{uuid}/

Response includes:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "name": "Database Server Upgrade",
  "affected_offerings": [
    {
      "url": "http://localhost:8000/api/maintenance-announcement-offerings/{uuid}/",
      "uuid": "550e8400-e29b-41d4-a716-446655440001",
      "maintenance": "http://localhost:8000/api/maintenance-announcements/{uuid}/",
      "offering": "http://localhost:8000/api/marketplace-offerings/{uuid}/",
      "impact_level": 3,
      "impact_level_display": "Partial outage",
      "impact_description": "API endpoints will be unavailable during database migration",
      "offering_name": "My Service API"
    }
  ]
}

Permission System

Authorization Model

MaintenanceAnnouncement uses Waldur's standard permission system:

  • Service Provider Path: service_provider__customer
  • Automatic Filtering: GenericRoleFilter handles visibility
  • Role-Based Access: Permissions tied to service provider ownership

User Permissions

Staff Users:

  • Full access to all maintenance announcements
  • Can perform all state transitions
  • Can create/update/delete any announcement

Service Provider Owners:

  • Full access to their service provider's maintenance announcements
  • Can perform all state transitions on their announcements
  • Can create/update/delete their announcements

Other Users:

  • No access to maintenance announcements (404 Not Found)
  • Cannot view or modify any maintenance data

Key Points

Affected Offerings Management

  • Separate Endpoint: Affected offerings are managed via /api/maintenance-announcement-offerings/
  • Read-Only Field: The affected_offerings field in MaintenanceAnnouncement is read-only
  • Two-Step Process: Create maintenance announcement first, then add affected offerings
  • Automatic Population: The affected_offerings field automatically reflects associated records
  • Individual Management: Each affected offering can be updated or deleted independently

Important Notes

  • You cannot include affected_offerings directly in the MaintenanceAnnouncement POST/PATCH requests
  • Affected offerings inherit the same permission model as the parent maintenance announcement
  • Impact levels and descriptions are specific to each offering-maintenance relationship
  • Deleting a maintenance announcement will cascade delete all associated affected offerings

AdminAnnouncement Integration Notes

  • Automatic lifecycle: AdminAnnouncements are automatically created/updated/deleted based on maintenance state
  • Manual deletion handling: If an AdminAnnouncement is manually deleted, the maintenance relationship is gracefully cleared (SET_NULL)
  • Content synchronization: AdminAnnouncement content automatically updates when maintenance message or type changes
  • Enhanced API: AdminAnnouncement API dynamically includes maintenance fields when associated with maintenance
  • No manual management needed: The integration is fully automated - no manual AdminAnnouncement creation required

Mixin classes documentation

This document lists all mixin classes found in the Waldur codebase.

Mixin Name Module Short Description
BaseChecklistMixin waldur_core.checklist.mixins Base mixin providing common checklist functionality
ReviewerChecklistMixin waldur_core.checklist.mixins Mixin for ViewSets that provide checklist review functionality to reviewers
UserChecklistMixin waldur_core.checklist.mixins Mixin for ViewSets that provide checklist functionality to end users
CopyButtonMixin waldur_core.core.admin Mixin to add copy-to-clipboard functionality to form fields in Django admin
ExcludedFieldsAdminMixin waldur_core.core.admin This mixin allows to toggle display of fields in Django model admin according...
ExtraActionsMixin waldur_core.core.admin Allows to add extra actions to admin list page
ExtraActionsObjectMixin waldur_core.core.admin Allows to add extra actions to admin object edit page
HideAdminOriginalMixin waldur_core.core.admin Encapsulate all admin options and functionality for a given model
NativeNameAdminMixin waldur_core.core.admin This mixin allows to toggle display of fields in Django model admin according...
ReadOnlyAdminMixin waldur_core.core.admin Disables all editing capabilities
DeleteExecutorMixin waldur_core.core.executors Delete object on success or if force flag is enabled
ErrorExecutorMixin waldur_core.core.executors Set object as erred on fail
SuccessExecutorMixin waldur_core.core.executors Set object as OK on success, cleanup action and its details
GenericKeyMixin waldur_core.core.managers Filtering by generic key field Support filtering by: - generic key directly...
CreateExecutorMixin waldur_core.core.mixins Mixin to execute create operations using background executors
DeleteExecutorMixin waldur_core.core.mixins Mixin to execute delete operations using background executors
EagerLoadMixin waldur_core.core.mixins Reduce number of requests to DB
ExecutorMixin waldur_core.core.mixins Execute create/update/delete operation with executor
GetValueMixin waldur_core.core.mixins Mixin to provide helper method for getting values from attrs or instance
ProjectNameTemplateMixin waldur_core.core.mixins Mixin for models that need to generate project names from templates
ReviewMixin waldur_core.core.mixins An abstract base class model that provides self-updating created and ``mo...
ReviewStateMixin waldur_core.core.mixins Make subclasses preserve the alters_data attribute on overridden methods
ScopeMixin waldur_core.core.mixins Make subclasses preserve the alters_data attribute on overridden methods
UpdateExecutorMixin waldur_core.core.mixins Mixin to execute update operations using background executors
ActionMixin waldur_core.core.models Mixin for action tracking with state management
BackendMixin waldur_core.core.models Mixin to add standard backend_id field
BackendModelMixin waldur_core.core.models Mixin for models connected to backend objects
DescendantMixin waldur_core.core.models Mixin to provide child-parent relationships
DescribableMixin waldur_core.core.models Mixin to add a standardized "description" field
ErrorMessageMixin waldur_core.core.models Mixin to add standardized error handling fields
LastSyncMixin waldur_core.core.models Mixin to track last synchronization time
NameMixin waldur_core.core.models Mixin to add a standardized "name" field with validation
RuntimeStateMixin waldur_core.core.models Mixin to provide runtime state tracking
SlugMixin waldur_core.core.models Mixin to automatically generate a name-based slug
StateMixin waldur_core.core.models Mixin implementing finite state machine (FSM) functionality
UiDescribableMixin waldur_core.core.models Mixin to add a standardized "description" and "icon url" fields
UserDetailsMatchMixin waldur_core.core.models Make subclasses preserve the alters_data attribute on overridden methods
UserDetailsMixin waldur_core.core.models This mixin is shared by User and Invitation model
UuidMixin waldur_core.core.models Mixin to identify models by UUID
LookupMixin waldur_core.core.nested_routers Deprecated
NestedMixin waldur_core.core.nested_routers Mixin for creating nested routers that handle hierarchical URL structures
AugmentedSerializerMixin waldur_core.core.serializers This mixin provides several extensions to stock Serializer class: 1
RestrictedSerializerMixin waldur_core.core.serializers This mixin allows to specify list of fields to be rendered by serializer
SlugSerializerMixin waldur_core.core.serializers Ensures that slug is editable only by staff
TranslatedModelSerializerMixin waldur_core.core.serializers A ModelSerializer is just a regular Serializer, except that: * A set of ...
ExtensionTaskMixin waldur_core.core.tasks This mixin allows to skip task scheduling if extension is disabled
ActionMethodMixin waldur_core.core.views Implements helper methods for viewset when use separate nested endpoints for ...
CheckExtensionMixin waldur_core.core.views Raise exception if extension is disabled
ConstanceCheckExtensionMixin waldur_core.core.views Raise exception if extension is disabled
CreateReversionMixin waldur_core.core.views Mixin to automatically create revision tracking for create operations
UpdateReversionMixin waldur_core.core.views Mixin to automatically create revision tracking for update operations
LoggableMixin waldur_core.logging.mixins Mixin to serialize model in logs
EventTypesMixin waldur_core.logging.models Mixin to add a event_types and event_groups fields
UuidMixin waldur_core.logging.models Make subclasses preserve the alters_data attribute on overridden methods
ImageModelMixin waldur_core.media.mixins Make subclasses preserve the alters_data attribute on overridden methods
PermissionMixin waldur_core.permissions.mixins Base permission management mixin for customer and project
UserRoleMixin waldur_core.permissions.views Mixin to provide user role management functionality for viewsets
ExtendableQuotaModelMixin waldur_core.quotas.models Allows to add quotas to model in runtime
QuotaModelMixin waldur_core.quotas.models Add general fields and methods to model for quotas usage
SharedQuotaMixin waldur_core.quotas.models This mixin updates quotas for several scopes
ChangeReadonlyMixin waldur_core.structure.admin Mixin to set different readonly fields for add and change views in Django admin
FormRequestAdminMixin waldur_core.structure.admin This mixin allows you to get current request user in the model admin form, wh...
ProtectedModelMixin waldur_core.structure.admin Mixin to handle protected model deletion errors gracefully in Django admin
CoordinatesMixin waldur_core.structure.mixins Mixin to add a latitude and longitude fields
IPCoordinatesMixin waldur_core.structure.mixins Mixin to add a latitude and longitude fields
CustomerDetailsMixin waldur_core.structure.models Mixin containing customer detail fields
ProjectOECDFOS2007CodeMixin waldur_core.structure.models Mixin providing OECD FOS 2007 classification codes for research projects
ServiceAccountMixin waldur_core.structure.models Mixin for models that support service accounts
StructureLoggableMixin waldur_core.structure.models Extends LoggableMixin with structure-specific permission filtering
VATMixin waldur_core.structure.models Add country and VAT number fields for tax compliance and record keeping
CountrySerializerMixin waldur_core.structure.serializers The BaseSerializer class provides a minimal class which may be used for writi...
FieldFilteringMixin waldur_core.structure.serializers Mixin allowing to filter fields by user
PermissionFieldFilteringMixin waldur_core.structure.serializers Mixin allowing to filter related fields
SshPublicKeySerializerMixin waldur_core.structure.serializers A type of ModelSerializer that uses hyperlinked relationships instead of pr...
ProjectMetadataTestMixin waldur_core.structure.tests.test_project_metadata Shared test setup and utilities for project metadata tests
CheckExtensionMixin waldur_freeipa.views Raise exception if extension is disabled
PeriodMixin waldur_mastermind.invoices.models Make subclasses preserve the alters_data attribute on overridden methods
ConnectedResourceMixin waldur_mastermind.marketplace.admin Protects object from modification if there are connected resources
ParentInlineMixin waldur_mastermind.marketplace.admin Mixin to get parent object from request in Django admin inline views
OfferingFilterMixin waldur_mastermind.marketplace.filters Mixin to provide common offering-related filters
CostEstimateMixin waldur_mastermind.marketplace.models Mixin for cost estimation functionality
RequestTypeMixin waldur_mastermind.marketplace.models Mixin for request type handling
ResourceDetailsMixin waldur_mastermind.marketplace.models Mixin combining resource details with cost estimation
SafeAttributesMixin waldur_mastermind.marketplace.models Mixin for safe attribute handling
ConnectedOfferingDetailsMixin waldur_mastermind.marketplace.views Mixin to provide offering details action for connected resources
PublicViewsetMixin waldur_mastermind.marketplace.views Mixin to allow anonymous access to offerings when configured
TenantMixin waldur_mastermind.marketplace_openstack.processors No description available
SelectiveDNSMockMixin waldur_mastermind.marketplace_remote.tests.dns_utils Mixin class that provides selective DNS mocking for test classes
ContainerExecutorMixin waldur_mastermind.marketplace_script.utils Mixin to execute scripts in containers for marketplace script processing
EstimatedCostPolicyMixin waldur_mastermind.policy.models Make subclasses preserve the alters_data attribute on overridden methods
OfferingPolicySerializerMixin waldur_mastermind.policy.serializers This mixin provides several extensions to stock Serializer class: 1
BackendNameMixin waldur_mastermind.support.models Make subclasses preserve the alters_data attribute on overridden methods
FileMixin waldur_mastermind.support.models Mixin to provide file-related functionality and properties
CheckExtensionMixin waldur_mastermind.support.views Raise exception if extension is disabled
ActionDetailsMixin waldur_openstack.admin Encapsulate all admin options and functionality for a given model
ImageMetadataMixin waldur_openstack.admin Encapsulate all admin options and functionality for a given model
MetadataMixin waldur_openstack.admin Encapsulate all admin options and functionality for a given model
TenantQuotaMixin waldur_openstack.models It allows to update both service settings and shared tenant quotas
LimitedPerTypeThrottleMixin waldur_openstack.tasks No description available
TenantMixin waldur_openstack.tests.factories No description available
DataciteMixin waldur_pid.mixins A marker model for models that can be registered with PIDs and referred to in...
RoleMixin waldur_rancher.models Make subclasses preserve the alters_data attribute on overridden methods
SettingsMixin waldur_rancher.models Make subclasses preserve the alters_data attribute on overridden methods
SyncDestroyMixin waldur_rancher.views No description available
YamlMixin waldur_rancher.views No description available
UsageMixin waldur_slurm.models Make subclasses preserve the alters_data attribute on overridden methods
VirtualMachineMixin waldur_vmware.models Make subclasses preserve the alters_data attribute on overridden methods

Detailed Descriptions

BaseChecklistMixin

Module: waldur_core.checklist.mixins

Description: Base mixin providing common checklist functionality.

Provides shared helper methods used by both UserChecklistMixin and ReviewerChecklistMixin. Should not be used directly - use UserChecklistMixin or ReviewerChecklistMixin instead.

ReviewerChecklistMixin

Module: waldur_core.checklist.mixins

Description: Mixin for ViewSets that provide checklist review functionality to reviewers.

Provides actions for designated reviewers to view full checklist information including sensitive review logic: - checklist_review: Get full checklist with review logic exposed - completion_review_status: Get full completion status with review triggers exposed

Security Design: This mixin exposes privileged review information and should only be used with proper reviewer permission controls.

IMPORTANT: Must override permissions with app-specific reviewer checks: - checklist_review_permissions = [permission_factory(...)] # Reviewer permissions required - completion_review_status_permissions = [permission_factory(...)] # Reviewer permissions required

Base classes: BaseChecklistMixin

UserChecklistMixin

Module: waldur_core.checklist.mixins

Description: Mixin for ViewSets that provide checklist functionality to end users.

Provides actions for users filling in checklists or viewing their answers: - checklist: Get checklist questions with existing answers (hides review logic) - completion_status: Get completion status (hides review triggers) - submit_answers: Submit answers to checklist questions

Security Design: This mixin hides all review logic information to prevent users from gaming the system by seeing which answers trigger reviews.

Default permissions are IsAdminUser but should be overridden with app-specific permissions: - checklist_permissions = [permission_factory(...)] - completion_status_permissions = [permission_factory(...)] - submit_answers_permissions = [permission_factory(...)]

Base classes: BaseChecklistMixin

CopyButtonMixin

Module: waldur_core.core.admin

Description: Mixin to add copy-to-clipboard functionality to form fields in Django admin.

ExcludedFieldsAdminMixin

Module: waldur_core.core.admin

Description: This mixin allows to toggle display of fields in Django model admin according to custom logic. It's expected that inherited class has implemented excluded_fields property.

Base classes: ModelAdmin

ExtraActionsMixin

Module: waldur_core.core.admin

Description: Allows to add extra actions to admin list page.

ExtraActionsObjectMixin

Module: waldur_core.core.admin

Description: Allows to add extra actions to admin object edit page.

HideAdminOriginalMixin

Module: waldur_core.core.admin

Description: Encapsulate all admin options and functionality for a given model.

Base classes: ModelAdmin

NativeNameAdminMixin

Module: waldur_core.core.admin

Description: This mixin allows to toggle display of fields in Django model admin according to custom logic. It's expected that inherited class has implemented excluded_fields property.

Base classes: ExcludedFieldsAdminMixin

ReadOnlyAdminMixin

Module: waldur_core.core.admin

Description: Disables all editing capabilities. Please ensure that readonly_fields is specified in derived class.

DeleteExecutorMixin

Module: waldur_core.core.executors

Description: Delete object on success or if force flag is enabled

ErrorExecutorMixin

Module: waldur_core.core.executors

Description: Set object as erred on fail.

SuccessExecutorMixin

Module: waldur_core.core.executors

Description: Set object as OK on success, cleanup action and its details.

GenericKeyMixin

Module: waldur_core.core.managers

Description: Filtering by generic key field

Support filtering by: - generic key directly: = - is generic key null: __isnull=True|False

CreateExecutorMixin

Module: waldur_core.core.mixins

Description: Mixin to execute create operations using background executors.

Base classes: AsyncExecutor

DeleteExecutorMixin

Module: waldur_core.core.mixins

Description: Mixin to execute delete operations using background executors.

Base classes: AsyncExecutor

EagerLoadMixin

Module: waldur_core.core.mixins

Description: Reduce number of requests to DB.

Serializer should implement static method "eager_load", that selects objects that are necessary for serialization.

ExecutorMixin

Module: waldur_core.core.mixins

Description: Execute create/update/delete operation with executor

Base classes: CreateExecutorMixin, UpdateExecutorMixin, DeleteExecutorMixin

GetValueMixin

Module: waldur_core.core.mixins

Description: Mixin to provide helper method for getting values from attrs or instance.

ProjectNameTemplateMixin

Module: waldur_core.core.mixins

Description: Mixin for models that need to generate project names from templates.

Base classes: Model

ReviewMixin

Module: waldur_core.core.mixins

Description: An abstract base class model that provides self-updating created and modified fields.

Base classes: ReviewStateMixin, TimeStampedModel

ReviewStateMixin

Module: waldur_core.core.mixins

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

ScopeMixin

Module: waldur_core.core.mixins

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

UpdateExecutorMixin

Module: waldur_core.core.mixins

Description: Mixin to execute update operations using background executors.

Base classes: AsyncExecutor

ActionMixin

Module: waldur_core.core.models

Description: Mixin for action tracking with state management.

Extends StateMixin with action tracking fields including action name, action details (JSON), and task ID for background task tracking. Used for models that need to track ongoing operations.

Base classes: StateMixin

BackendMixin

Module: waldur_core.core.models

Description: Mixin to add standard backend_id field.

Provides a backend_id CharField for storing identifiers from external backend systems. Used for mapping local objects to their corresponding backend representations.

Base classes: Model

BackendModelMixin

Module: waldur_core.core.models

Description: Mixin for models connected to backend objects.

Represents models that are synchronized with external backend systems. These models cannot be created or updated via admin interface because backend queries are not supported in the admin.

DescendantMixin

Module: waldur_core.core.models

Description: Mixin to provide child-parent relationships.

Each related model can provide list of its parents through the get_parents() method. Used for hierarchical data structures where objects have parent-child relationships.

DescribableMixin

Module: waldur_core.core.models

Description: Mixin to add a standardized "description" field.

Base classes: Model

ErrorMessageMixin

Module: waldur_core.core.models

Description: Mixin to add standardized error handling fields.

Provides error_message and error_traceback TextField for storing error information and debugging details when operations fail.

Base classes: Model

LastSyncMixin

Module: waldur_core.core.models

Description: Mixin to track last synchronization time.

Provides a last_sync DateTimeField that defaults to the current time and is not editable through forms. Used for tracking when data was last synchronized with external systems.

Base classes: Model

NameMixin

Module: waldur_core.core.models

Description: Mixin to add a standardized "name" field with validation.

Provides a CharField with maximum length of 150 characters and validates the name using the validate_name validator.

Base classes: Model

RuntimeStateMixin

Module: waldur_core.core.models

Description: Mixin to provide runtime state tracking.

Adds a runtime_state field with predefined ONLINE/OFFLINE states. Used to track the current operational status of resources.

Base classes: Model

SlugMixin

Module: waldur_core.core.models

Description: Mixin to automatically generate a name-based slug.

Generates unique slugs based on the source field (default: 'name') during save operations. Uses generate_slug() to ensure uniqueness by appending numeric suffixes when needed.

Base classes: Model

StateMixin

Module: waldur_core.core.models

Description: Mixin implementing finite state machine (FSM) functionality.

Provides state management with transitions between creation, updating, deletion, OK, and error states. Includes error handling capabilities and concurrent transition support.

Base classes: ErrorMessageMixin, ConcurrentTransitionMixin

UiDescribableMixin

Module: waldur_core.core.models

Description: Mixin to add a standardized "description" and "icon url" fields.

Extends DescribableMixin with an icon_url field for UI display purposes. The icon_url field accepts URLs up to 500 characters.

Base classes: DescribableMixin

UserDetailsMatchMixin

Module: waldur_core.core.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

UserDetailsMixin

Module: waldur_core.core.models

Description: This mixin is shared by User and Invitation model. All fields are optional. User is populated with these details when invitation is approved. Note that civil_number and email fields are not included in this mixin because they have different constraints in User and Invitation model.

Base classes: Model

UuidMixin

Module: waldur_core.core.models

Description: Mixin to identify models by UUID.

Provides a UUID field for unique model identification. The UUID is automatically generated and used as a primary identifier.

Base classes: Model

LookupMixin

Module: waldur_core.core.nested_routers

Description: Deprecated.

No method override is needed since Django Rest Framework 2.4.

NestedMixin

Module: waldur_core.core.nested_routers

Description: Mixin for creating nested routers that handle hierarchical URL structures.

AugmentedSerializerMixin

Module: waldur_core.core.serializers

Description: This mixin provides several extensions to stock Serializer class:

  1. Add extra fields to serializer from dependent applications in a way that doesn't introduce circular dependencies.

    To achieve this, dependent application should subscribe to pre_serializer_fields signal and inject additional fields.

    Example of signal handler implementation:

    from waldur_core.structure.serializers import CustomerSerializer

    def add_customer_name(sender, fields, **kwargs): fields['customer_name'] = ReadOnlyField(source='customer.name')

    pre_serializer_fields.connect( handlers.add_customer_name, sender=CustomerSerializer )

  2. Declaratively add attributes fields of related entities for ModelSerializers.

    To achieve list related fields whose attributes you want to include.

    Example: class ProjectSerializer(AugmentedSerializerMixin, serializers.HyperlinkedModelSerializer): class Meta: model = models.Project fields = ( 'url', 'uuid', 'name', 'customer', 'customer_uuid', 'customer_name', ) related_paths = ('customer',)

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
    # This is equivalent to listing the fields explicitly,
# by default "uuid" and "name" fields of related object are added:

class ProjectSerializer(AugmentedSerializerMixin,
                        serializers.HyperlinkedModelSerializer):
    customer_uuid = serializers.UUIDField(read_only=True, source='customer.uuid')
    customer_name = serializers.ReadOnlyField(source='customer.name')
    class Meta:
        model = models.Project
        fields = (
            'url', 'uuid', 'name',
            'customer', 'customer_uuid', 'customer_name',
        )
        lookup_field = 'uuid'

# The fields of related object can be customized:

class ProjectSerializer(AugmentedSerializerMixin,
                        serializers.HyperlinkedModelSerializer):
    class Meta:
        model = models.Project
        fields = (
            'url', 'uuid', 'name',
            'customer', 'customer_uuid',
            'customer_name', 'customer_native_name',
        )
        related_paths = {
            'customer': ('uuid', 'name', 'native_name')
        }

  3. Protect some fields from change.

    Example: class ProjectSerializer(AugmentedSerializerMixin, serializers.HyperlinkedModelSerializer): class Meta: model = models.Project fields = ('url', 'uuid', 'name', 'customer') protected_fields = ('customer',)

  4. This mixin overrides "get_extra_kwargs" method and puts "view_name" to extra_kwargs or uses URL name specified in a model of serialized object.

RestrictedSerializerMixin

Module: waldur_core.core.serializers

Description: This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).

SlugSerializerMixin

Module: waldur_core.core.serializers

Description: Ensures that slug is editable only by staff

Base classes: Serializer

TranslatedModelSerializerMixin

Module: waldur_core.core.serializers

Description: A ModelSerializer is just a regular Serializer, except that:

  • A set of default fields are automatically populated.
  • A set of default validators are automatically populated.
  • Default .create() and .update() implementations are provided.

The process of automatically determining a set of serializer fields based on the model fields is reasonably complex, but you almost certainly don't need to dig into the implementation.

If the ModelSerializer class doesn't generate the set of fields that you need you should either declare the extra/differing fields explicitly on the serializer class, or simply use a Serializer class.

Base classes: ModelSerializer

ExtensionTaskMixin

Module: waldur_core.core.tasks

Description: This mixin allows to skip task scheduling if extension is disabled. Subclasses should implement "is_extension_disabled" method which returns boolean value.

Base classes: Task

ActionMethodMixin

Module: waldur_core.core.views

Description: Implements helper methods for viewset when use separate nested endpoints for create/edit relations objects. Example:

@decorators.action(detail=True, methods=["get", "post"]) def offerings(self, request, uuid=None): return self.action_list_method("requestedoffering_set")(self, request, uuid)

offerings_serializer_class = serializers.RequestedOfferingSerializer

def offering_detail(self, request, uuid=None, obj_uuid=None): return self.action_detail_method( "requestedoffering_set", delete_validators=[], update_validators=[ core_validators.StateValidator( RequestedOfferingStates.REQUESTED ) ], )(self, request, uuid, obj_uuid)

offering_detail_serializer_class = serializers.RequestedOfferingSerializer

CheckExtensionMixin

Module: waldur_core.core.views

Description: Raise exception if extension is disabled

ConstanceCheckExtensionMixin

Module: waldur_core.core.views

Description: Raise exception if extension is disabled

CreateReversionMixin

Module: waldur_core.core.views

Description: Mixin to automatically create revision tracking for create operations.

UpdateReversionMixin

Module: waldur_core.core.views

Description: Mixin to automatically create revision tracking for update operations.

LoggableMixin

Module: waldur_core.logging.mixins

Description: Mixin to serialize model in logs. Extends django model or custom class with fields extraction method.

EventTypesMixin

Module: waldur_core.logging.models

Description: Mixin to add a event_types and event_groups fields.

Base classes: Model

UuidMixin

Module: waldur_core.logging.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

ImageModelMixin

Module: waldur_core.media.mixins

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

PermissionMixin

Module: waldur_core.permissions.mixins

Description: Base permission management mixin for customer and project. It is expected that reverse permissions relation is created for this model. Provides method to grant, revoke and check object permissions.

UserRoleMixin

Module: waldur_core.permissions.views

Description: Mixin to provide user role management functionality for viewsets.

ExtendableQuotaModelMixin

Module: waldur_core.quotas.models

Description: Allows to add quotas to model in runtime.

Example: from waldur_core.quotas.fields import QuotaField

1
2
3
4
QuotaScopeModel.add_quota_field(
    name='quota_name',
    quota_field=QuotaField(...),
)

Base classes: QuotaModelMixin

QuotaModelMixin

Module: waldur_core.quotas.models

Description: Add general fields and methods to model for quotas usage.

Model with quotas have inherit this mixin. For quotas implementation such methods and fields have to be defined: - class Quota(QuotaModelMixin) - class with quotas fields as attributes.

Example: Customer(models.Model): ... Quotas(quotas_models.QuotaModelMixin.Quotas): nc_user_count = quotas_fields.QuotaField() # define user count quota for customers

Use such methods to change objects quotas: set_quota_limit, set_quota_usage, add_quota_usage.

Base classes: Model

SharedQuotaMixin

Module: waldur_core.quotas.models

Description: This mixin updates quotas for several scopes.

ChangeReadonlyMixin

Module: waldur_core.structure.admin

Description: Mixin to set different readonly fields for add and change views in Django admin.

FormRequestAdminMixin

Module: waldur_core.structure.admin

Description: This mixin allows you to get current request user in the model admin form, which then passed to add_user method, so that user which granted role, is stored in the permission model.

ProtectedModelMixin

Module: waldur_core.structure.admin

Description: Mixin to handle protected model deletion errors gracefully in Django admin.

CoordinatesMixin

Module: waldur_core.structure.mixins

Description: Mixin to add a latitude and longitude fields

Base classes: Model

IPCoordinatesMixin

Module: waldur_core.structure.mixins

Description: Mixin to add a latitude and longitude fields

Base classes: CoordinatesMixin

CustomerDetailsMixin

Module: waldur_core.structure.models

Description: Mixin containing customer detail fields.

Provides comprehensive customer information fields including native name, contact details, agreement number, email, phone, address, banking information, and external system integration.

Base classes: NameMixin, VATMixin, CoordinatesMixin

ProjectOECDFOS2007CodeMixin

Module: waldur_core.structure.models

Description: Mixin providing OECD FOS 2007 classification codes for research projects.

Provides standardized classification codes for different scientific fields according to the OECD Fields of Science and Technology (FOS) 2007 standard. Used to categorize research projects by their scientific domain.

Base classes: Model

ServiceAccountMixin

Module: waldur_core.structure.models

Description: Mixin for models that support service accounts.

Provides functionality for managing service accounts with configurable maximum limits. Used by customers and projects to control service account creation.

Base classes: Model

StructureLoggableMixin

Module: waldur_core.structure.models

Description: Extends LoggableMixin with structure-specific permission filtering.

Provides permission filtering for logging operations based on structure-specific user permissions and visibility rules.

Base classes: LoggableMixin

VATMixin

Module: waldur_core.structure.models

Description: Add country and VAT number fields for tax compliance and record keeping. VAT validation is optional and can be done manually or through external services.

Base classes: Model

CountrySerializerMixin

Module: waldur_core.structure.serializers

Description: The BaseSerializer class provides a minimal class which may be used for writing custom serializer implementations.

Note that we strongly restrict the ordering of operations/properties that may be used on the serializer in order to enforce correct usage.

In particular, if a data= argument is passed then:

.is_valid() - Available. .initial_data - Available. .validated_data - Only available after calling is_valid() .errors - Only available after calling is_valid() .data - Only available after calling is_valid()

If a data= argument is not passed then:

.is_valid() - Not available. .initial_data - Not available. .validated_data - Not available. .errors - Not available. .data - Available.

Base classes: Serializer

FieldFilteringMixin

Module: waldur_core.structure.serializers

Description: Mixin allowing to filter fields by user.

In order to constrain the list of fields implement get_filtered_field() method returning list of tuples (field name, func for check access).

PermissionFieldFilteringMixin

Module: waldur_core.structure.serializers

Description: Mixin allowing to filter related fields.

In order to constrain the list of entities that can be used as a value for the field:

  1. Make sure that the entity in question has corresponding Permission class defined.

  2. Implement get_filtered_field_names() method in the class that this mixin is mixed into and return the field in question from that method.

SshPublicKeySerializerMixin

Module: waldur_core.structure.serializers

Description: A type of ModelSerializer that uses hyperlinked relationships instead of primary key relationships. Specifically:

  • A 'url' field is included instead of the 'id' field.
  • Relationships to other instances are hyperlinks, instead of primary keys.

Base classes: HyperlinkedModelSerializer

ProjectMetadataTestMixin

Module: waldur_core.structure.tests.test_project_metadata

Description: Shared test setup and utilities for project metadata tests.

CheckExtensionMixin

Module: waldur_freeipa.views

Description: Raise exception if extension is disabled

Base classes: ConstanceCheckExtensionMixin

PeriodMixin

Module: waldur_mastermind.invoices.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

ConnectedResourceMixin

Module: waldur_mastermind.marketplace.admin

Description: Protects object from modification if there are connected resources.

ParentInlineMixin

Module: waldur_mastermind.marketplace.admin

Description: Mixin to get parent object from request in Django admin inline views.

OfferingFilterMixin

Module: waldur_mastermind.marketplace.filters

Description: Mixin to provide common offering-related filters.

Base classes: FilterSet

CostEstimateMixin

Module: waldur_mastermind.marketplace.models

Description: Mixin for cost estimation functionality.

Provides cost estimation with plan-based calculations and policy validation. Used for calculating costs based on limits and plans with policy compliance checking.

Base classes: Model

RequestTypeMixin

Module: waldur_mastermind.marketplace.models

Description: Mixin for request type handling.

Extends CostEstimateMixin with request type-specific cost calculation for different operation types (CREATE, UPDATE, etc.). Provides pricing logic based on request type and plan switching.

Base classes: CostEstimateMixin

ResourceDetailsMixin

Module: waldur_mastermind.marketplace.models

Description: Mixin combining resource details with cost estimation.

Provides comprehensive resource details including cost estimation, safe attributes, and end date management. Used for resource lifecycle management and billing calculations.

Base classes: SafeAttributesMixin, CostEstimateMixin, NameMixin, SlugMixin, DescribableMixin

SafeAttributesMixin

Module: waldur_mastermind.marketplace.models

Description: Mixin for safe attribute handling.

Provides safe attribute functionality excluding secret attributes. Used for secure attribute access that filters out sensitive information like passwords and credentials.

Base classes: Model

ConnectedOfferingDetailsMixin

Module: waldur_mastermind.marketplace.views

Description: Mixin to provide offering details action for connected resources.

PublicViewsetMixin

Module: waldur_mastermind.marketplace.views

Description: Mixin to allow anonymous access to offerings when configured.

TenantMixin

Module: waldur_mastermind.marketplace_openstack.processors

Description: No description available.

SelectiveDNSMockMixin

Module: waldur_mastermind.marketplace_remote.tests.dns_utils

Description: Mixin class that provides selective DNS mocking for test classes.

Usage: class MyTestClass(SelectiveDNSMockMixin, test.APITransactionTestCase): def setUp(self): super().setUp() # Your additional setup code here

ContainerExecutorMixin

Module: waldur_mastermind.marketplace_script.utils

Description: Mixin to execute scripts in containers for marketplace script processing.

EstimatedCostPolicyMixin

Module: waldur_mastermind.policy.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: PeriodMixin

OfferingPolicySerializerMixin

Module: waldur_mastermind.policy.serializers

Description: This mixin provides several extensions to stock Serializer class:

  1. Add extra fields to serializer from dependent applications in a way that doesn't introduce circular dependencies.

    To achieve this, dependent application should subscribe to pre_serializer_fields signal and inject additional fields.

    Example of signal handler implementation:

    from waldur_core.structure.serializers import CustomerSerializer

    def add_customer_name(sender, fields, **kwargs): fields['customer_name'] = ReadOnlyField(source='customer.name')

    pre_serializer_fields.connect( handlers.add_customer_name, sender=CustomerSerializer )

  2. Declaratively add attributes fields of related entities for ModelSerializers.

    To achieve list related fields whose attributes you want to include.

    Example: class ProjectSerializer(AugmentedSerializerMixin, serializers.HyperlinkedModelSerializer): class Meta: model = models.Project fields = ( 'url', 'uuid', 'name', 'customer', 'customer_uuid', 'customer_name', ) related_paths = ('customer',)

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
    # This is equivalent to listing the fields explicitly,
# by default "uuid" and "name" fields of related object are added:

class ProjectSerializer(AugmentedSerializerMixin,
                        serializers.HyperlinkedModelSerializer):
    customer_uuid = serializers.UUIDField(read_only=True, source='customer.uuid')
    customer_name = serializers.ReadOnlyField(source='customer.name')
    class Meta:
        model = models.Project
        fields = (
            'url', 'uuid', 'name',
            'customer', 'customer_uuid', 'customer_name',
        )
        lookup_field = 'uuid'

# The fields of related object can be customized:

class ProjectSerializer(AugmentedSerializerMixin,
                        serializers.HyperlinkedModelSerializer):
    class Meta:
        model = models.Project
        fields = (
            'url', 'uuid', 'name',
            'customer', 'customer_uuid',
            'customer_name', 'customer_native_name',
        )
        related_paths = {
            'customer': ('uuid', 'name', 'native_name')
        }

  3. Protect some fields from change.

    Example: class ProjectSerializer(AugmentedSerializerMixin, serializers.HyperlinkedModelSerializer): class Meta: model = models.Project fields = ('url', 'uuid', 'name', 'customer') protected_fields = ('customer',)

  4. This mixin overrides "get_extra_kwargs" method and puts "view_name" to extra_kwargs or uses URL name specified in a model of serialized object.

Base classes: AugmentedSerializerMixin

BackendNameMixin

Module: waldur_mastermind.support.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

FileMixin

Module: waldur_mastermind.support.models

Description: Mixin to provide file-related functionality and properties.

CheckExtensionMixin

Module: waldur_mastermind.support.views

Description: Raise exception if extension is disabled

Base classes: ConstanceCheckExtensionMixin

ActionDetailsMixin

Module: waldur_openstack.admin

Description: Encapsulate all admin options and functionality for a given model.

Base classes: ModelAdmin

ImageMetadataMixin

Module: waldur_openstack.admin

Description: Encapsulate all admin options and functionality for a given model.

Base classes: ModelAdmin

MetadataMixin

Module: waldur_openstack.admin

Description: Encapsulate all admin options and functionality for a given model.

Base classes: ModelAdmin

TenantQuotaMixin

Module: waldur_openstack.models

Description: It allows to update both service settings and shared tenant quotas.

Base classes: SharedQuotaMixin

LimitedPerTypeThrottleMixin

Module: waldur_openstack.tasks

Description: No description available.

TenantMixin

Module: waldur_openstack.tests.factories

Description: No description available.

DataciteMixin

Module: waldur_pid.mixins

Description: A marker model for models that can be registered with PIDs and referred to in a Datacite PID way.

Base classes: Model

RoleMixin

Module: waldur_rancher.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

SettingsMixin

Module: waldur_rancher.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

SyncDestroyMixin

Module: waldur_rancher.views

Description: No description available.

YamlMixin

Module: waldur_rancher.views

Description: No description available.

UsageMixin

Module: waldur_slurm.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

VirtualMachineMixin

Module: waldur_vmware.models

Description: Make subclasses preserve the alters_data attribute on overridden methods.

Base classes: Model

Models

Structure application models

classDiagram
    direction TB
    class OrganizationGroup {
        +int id [PK]
        +string name
        +string uuid
        +OrganizationGroup parent [FK]
    }
    class Customer {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +image image
        +string name
        +string slug
        +string uuid
        +float latitude
        +float longitude
        +string vat_code
        +string vat_name
        +string vat_address
        +string country
        +string native_name
        +string abbreviation
        +string contact_details
        +string agreement_number
        +int sponsor_number
        +string email
        +string phone_number
        +string access_subnets
        +string backend_id
        +string registration_code
        +string homepage
        +string domain
        +string address
        +string postal
        +string bank_name
        +string bank_account
        +int max_service_accounts
        +datetime accounting_start_date
        +decimal default_tax_percent
        +bool blocked
        +bool archived
        +Checklist project_metadata_checklist [FK]
        +OrganizationGroup organization_groups
    }
    class ProjectType {
        +int id [PK]
        +string description
        +string name
        +string uuid
    }
    class Project {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +bool is_removed
        +image image
        +string description
        +string slug
        +string uuid
        +string backend_id
        +int max_service_accounts
        +string oecd_fos_2007_code
        +string name
        +date start_date
        +date end_date
        +User end_date_requested_by [FK]
        +ProjectType type [FK]
        +bool is_industry
        +Customer customer [FK]
    }
    Customer "*" -- "*" OrganizationGroup : organization_groups
    OrganizationGroup "*" -- "1" OrganizationGroup : parent
    Project "*" -- "1" Customer : customer
    Project "*" -- "1" ProjectType : type
    Project "*" -- "1" User : end_date_requested_by

Permissions application models

classDiagram
    direction TB
    class Role {
        +int id [PK]
        +string description
        +string uuid
        +string name
        +bool is_system_role
        +bool is_active
        +ContentType content_type [FK]
    }
    class UserRole {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string uuid
        +ContentType content_type [FK]
        +int object_id
        +User user [FK]
        +Role role [FK]
        +User created_by [FK]
        +datetime expiration_time
        +bool is_active
    }
    class RolePermission {
        +int id [PK]
        +Role role [FK]
        +string permission
    }
    RolePermission "*" -- "1" Role : role
    UserRole "*" -- "1" Role : role
    UserRole "*" -- "1" User : created_by
    UserRole "*" -- "1" User : user

Marketplace category models

classDiagram
    direction TB
    class CategoryGroup {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string uuid
        +string title
        +file icon
        +string description
    }
    class Category {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string uuid
        +string backend_id
        +string title
        +file icon
        +string description
        +bool default_vm_category
        +bool default_volume_category
        +bool default_tenant_category
        +CategoryGroup group [FK]
    }
    class CategoryColumn {
        +int id [PK]
        +string uuid
        +Category category [FK]
        +int index
        +string title
        +string attribute
        +string widget
    }
    class CategoryComponent {
        +int id [PK]
        +string description
        +string uuid
        +string name
        +string type
        +string measured_unit
        +Category category [FK]
    }
    class CategoryComponentUsage {
        +int id [PK]
        +ContentType content_type [FK]
        +int object_id
        +CategoryComponent component [FK]
        +date date
        +BigIntegerField reported_usage
        +BigIntegerField fixed_usage
    }
    Category "*" -- "1" CategoryGroup : group
    CategoryColumn "*" -- "1" Category : category
    CategoryComponent "*" -- "1" Category : category
    CategoryComponentUsage "*" -- "1" CategoryComponent : component

Marketplace catalog models

classDiagram
    direction TB
    class Section {
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string key [PK]
        +string title
        +Category category [FK]
        +bool is_standalone
    }
    class Attribute {
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string key [PK]
        +string title
        +Section section [FK]
        +string type
        +bool required
        +JSONField default
    }
    class AttributeOption {
        +int id [PK]
        +Attribute attribute [FK]
        +string key
        +string title
    }
    class Offering {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +image image
        +string description
        +string name
        +string slug
        +string uuid
        +string backend_id
        +ContentType content_type [FK]
        +int object_id
        +JSONField backend_metadata
        +float latitude
        +float longitude
        +string datacite_doi
        +int citation_count
        +string error_message
        +file thumbnail
        +string remote_image_uuid
        +string full_description
        +string vendor_details
        +string getting_started
        +string integration_guide
        +Category category [FK]
        +Checklist compliance_checklist [FK]
        +Customer customer [FK]
        +Project project [FK]
        +Offering parent [FK]
        +JSONField attributes
        +JSONField options
        +JSONField resource_options
        +JSONField plugin_options
        +JSONField secret_options
        +string privacy_policy_link
        +string country
        +string type
        +FSMIntegerField state
        +string paused_reason
        +bool shared
        +bool billable
        +bool support_per_user_consumption_limitation
        +string access_url
        +OrganizationGroup organization_groups
    }
    class OfferingComponent {
        +int id [PK]
        +string description
        +string uuid
        +string backend_id
        +ContentType content_type [FK]
        +int object_id
        +string article_code
        +string name
        +string type
        +string measured_unit
        +Offering offering [FK]
        +CategoryComponent parent [FK]
        +string billing_type
        +string limit_period
        +int limit_amount
        +int unit_factor
        +int max_value
        +int min_value
        +int max_available_limit
        +bool is_boolean
        +int default_limit
    }
    Attribute "*" -- "1" Section : section
    AttributeOption "*" -- "1" Attribute : attribute
    Offering "*" -- "1" Offering : parent
    OfferingComponent "*" -- "1" Offering : offering

Marketplace provisioning models

classDiagram
    direction TB
    class Plan {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string description
        +string name
        +string uuid
        +string backend_id
        +ContentType content_type [FK]
        +int object_id
        +decimal unit_price
        +string unit
        +string article_code
        +Offering offering [FK]
        +bool archived
        +int max_amount
        +OrganizationGroup organization_groups
    }
    class PlanComponent {
        +int id [PK]
        +Plan plan [FK]
        +OfferingComponent component [FK]
        +int amount
        +decimal price
        +decimal future_price
    }
    class Resource {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string description
        +string name
        +string slug
        +string uuid
        +string error_message
        +string error_traceback
        +datetime last_sync
        +string backend_id
        +ContentType content_type [FK]
        +int object_id
        +JSONField backend_metadata
        +decimal cost
        +Plan plan [FK]
        +JSONField limits
        +Offering offering [FK]
        +JSONField attributes
        +date end_date
        +User end_date_requested_by [FK]
        +FSMIntegerField state
        +Project project [FK]
        +Resource parent [FK]
        +JSONField report
        +JSONField options
        +JSONField current_usages
        +string effective_id
        +bool downscaled
        +bool restrict_member_access
        +bool paused
    }
    class Order {
        +int id [PK]
        +AutoCreatedField created
        +AutoLastModifiedField modified
        +string uuid
        +string error_message
        +string error_traceback
        +string backend_id
        +decimal cost
        +Plan plan [FK]
        +JSONField limits
        +int type
        +Offering offering [FK]
        +JSONField attributes
        +Plan old_plan [FK]
        +Project project [FK]
        +Resource resource [FK]
        +FSMIntegerField state
        +string output
        +User created_by [FK]
        +User consumer_reviewed_by [FK]
        +datetime consumer_reviewed_at
        +User provider_reviewed_by [FK]
        +datetime provider_reviewed_at
        +string callback_url
        +string termination_comment
        +datetime completed_at
    }
    Order "*" -- "1" Plan : old_plan
    Order "*" -- "1" Plan : plan
    Order "*" -- "1" Resource : resource
    PlanComponent "*" -- "1" Plan : plan
    Resource "*" -- "1" Plan : plan
    Resource "*" -- "1" Resource : parent

Offering Compliance API Documentation

Offering compliance functionality enables service providers to define and track compliance requirements for their marketplace offerings. Users of these offerings must complete compliance checklists, and service providers can monitor completion status across all their offerings.

Overview

The offering compliance system allows service providers to:

  • Define compliance checklists for their offerings
  • Track user compliance across all offerings
  • Monitor completion rates and identify users needing attention
  • Ensure regulatory and organizational compliance requirements are met

Architecture

The system consists of three main components:

  1. Compliance Checklists - Customizable questionnaires attached to offerings
  2. Offering Users - Users who have access to offerings and must complete compliance
  3. Service Provider Management - Dashboard and APIs for compliance monitoring

Configuration

Setting Up Offering Compliance

1. Create a Compliance Checklist

First, create a checklist with type offering_compliance:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "name": "Security Compliance Checklist",
  "description": "Required security compliance information for cloud services",
  "checklist_type": "offering_compliance"
}

2. Add Questions to the Checklist

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /api/checklists-admin/questions/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "checklist": "<checklist-uuid>",
  "description": "Have you completed security training?",
  "question_type": "boolean",
  "required": true,
  "order": 1
}

3. Assign Checklist to Offering

Attach the compliance checklist to an offering:

1
2
3
4
5
6
7
PATCH /api/marketplace-provider-offerings/<offering-uuid>/
Content-Type: application/json
Authorization: Token <service-provider-token>

{
  "compliance_checklist": "<checklist-uuid>"
}

API Endpoints

Checking Offering Compliance Requirements

Before accessing compliance-specific endpoints, you can check if an offering has compliance requirements using the standard offering API.

Get Offering Details

1
GET /api/marketplace-public-offerings/<offering-uuid>/

Response includes:

1
2
3
4
5
6
{
  "uuid": "offering-uuid",
  "name": "Cloud VM Service",
  "has_compliance_requirements": true,
  // ... other offering fields
}

Field Description:

Field Type Description
has_compliance_requirements Boolean Indicates whether this offering requires users to complete compliance checklists

Usage:

  • true - This offering requires compliance. Users must complete checklists before using the service.
  • false - This offering has no compliance requirements. Users can use the service without additional checklists.

For Offering Users

These endpoints allow offering users to view and complete their compliance requirements.

Base URL Pattern

1
/api/marketplace-offering-users/<offering-user-uuid>/

1. Get Compliance Checklist

Retrieves the compliance checklist for an offering user, including all questions and existing answers.

1
2
GET /api/marketplace-offering-users/<offering-user-uuid>/checklist/
Authorization: Token <user-token>

Permissions Required:

  • The authenticated user must be the offering user
  • Service provider staff with UPDATE_OFFERING_USER permission

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "checklist": {
    "uuid": "checklist-uuid",
    "name": "Security Compliance Checklist",
    "description": "Required security compliance information",
    "checklist_type": "offering_compliance"
  },
  "completion": {
    "uuid": "completion-uuid",
    "is_completed": false,
    "completion_percentage": 50.0,
    "unanswered_required_questions": [
      {
        "uuid": "question-uuid",
        "description": "Data handling procedures",
        "question_type": "text_area"
      }
    ],
    "checklist_name": "Security Compliance Checklist",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-15T14:20:00Z"
  },
  "questions": [
    {
      "uuid": "question-uuid-1",
      "description": "Have you completed security training?",
      "question_type": "boolean",
      "required": true,
      "order": 1,
      "existing_answer": {
        "uuid": "answer-uuid",
        "answer_data": true,
        "user": "user-uuid",
        "user_name": "John Doe",
        "created": "2024-01-15T14:20:00Z"
      }
    },
    {
      "uuid": "question-uuid-2",
      "description": "Compliance level",
      "question_type": "single_select",
      "required": true,
      "order": 2,
      "existing_answer": null,
      "question_options": [
        {
          "uuid": "option-uuid-1",
          "label": "Basic",
          "order": 1
        },
        {
          "uuid": "option-uuid-2",
          "label": "Advanced",
          "order": 2
        }
      ]
    }
  ]
}

2. Get Completion Status

Retrieves only the completion status for the offering user's compliance.

1
2
GET /api/marketplace-offering-users/<offering-user-uuid>/completion_status/
Authorization: Token <user-token>

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "uuid": "completion-uuid",
  "is_completed": false,
  "completion_percentage": 75.0,
  "unanswered_required_questions": [
    {
      "uuid": "question-uuid",
      "description": "Emergency contact",
      "question_type": "text_input"
    }
  ],
  "checklist_name": "Security Compliance Checklist",
  "created": "2024-01-15T10:30:00Z",
  "modified": "2024-01-15T14:20:00Z"
}

3. Submit Compliance Answers

Submit or update answers to compliance questions.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
POST /api/marketplace-offering-users/<offering-user-uuid>/submit_answers/
Content-Type: application/json
Authorization: Token <user-token>

[
  {
    "question_uuid": "question-uuid-1",
    "answer_data": true
  },
  {
    "question_uuid": "question-uuid-2",
    "answer_data": "Completed advanced security training on 2024-01-10"
  },
  {
    "question_uuid": "question-uuid-3",
    "answer_data": ["option-uuid-1"]
  }
]

Answer Data Formats:

Question Type Format Example
text_input String "Short text answer"
text_area String "Detailed compliance information"
boolean Boolean true or false
number Number 42 or 3.14
single_select Array with one UUID ["option-uuid"]
multi_select Array with multiple UUIDs ["option-1", "option-2"]

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "detail": "Answers submitted successfully",
  "completion": {
    "uuid": "completion-uuid",
    "is_completed": true,
    "completion_percentage": 100.0,
    "unanswered_required_questions": [],
    "checklist_name": "Security Compliance Checklist",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-15T15:45:00Z"
  }
}

For Service Providers

These endpoints allow service providers to monitor and manage compliance across all their offerings.

Base URL Pattern

1
/api/marketplace-service-providers/<service-provider-uuid>/compliance/

1. Compliance Overview

Get aggregated compliance statistics for all offerings managed by the service provider.

1
2
GET /api/marketplace-service-providers/<service-provider-uuid>/compliance/compliance_overview/
Authorization: Token <service-provider-token>

Permissions Required:

  • Customer owner or staff with LIST_SERVICE_PROVIDER_CUSTOMERS permission

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
[
  {
    "offering_uuid": "offering-uuid-1",
    "offering_name": "Cloud VM Service",
    "checklist_name": "Security Compliance Checklist",
    "total_users": 25,
    "users_with_completions": 23,
    "completed_users": 18,
    "pending_users": 5,
    "compliance_rate": 72.0
  },
  {
    "offering_uuid": "offering-uuid-2",
    "offering_name": "Storage Service",
    "checklist_name": "Data Protection Compliance",
    "total_users": 15,
    "users_with_completions": 15,
    "completed_users": 15,
    "pending_users": 0,
    "compliance_rate": 100.0
  },
  {
    "offering_uuid": "offering-uuid-3",
    "offering_name": "Basic Compute",
    "checklist_name": null,
    "total_users": 10,
    "users_with_completions": 0,
    "completed_users": 0,
    "pending_users": 0,
    "compliance_rate": 0.0
  }
]

2. List Offering Users with Compliance Status

Get detailed compliance status for individual offering users.

1
2
GET /api/marketplace-service-providers/<service-provider-uuid>/compliance/offering_users/
Authorization: Token <service-provider-token>

Query Parameters:

Parameter Type Description
offering_uuid UUID Filter by specific offering
compliance_status String Filter by status: completed, pending, no_checklist

Example Request:

1
GET /api/marketplace-service-providers/<uuid>/compliance/offering_users/?compliance_status=pending

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
[
  {
    "uuid": "offering-user-uuid-1",
    "user_full_name": "John Doe",
    "user_email": "john.doe@example.com",
    "offering_name": "Cloud VM Service",
    "checklist_name": "Security Compliance Checklist",
    "username": "johndoe",
    "state": "OK",
    "completion_percentage": 75,
    "compliance_status": "pending",
    "last_updated": "2024-01-19T10:30:00Z",
    "created": "2024-01-15T09:00:00Z"
  },
  {
    "uuid": "offering-user-uuid-2",
    "user_full_name": "Jane Smith",
    "user_email": "jane.smith@example.com",
    "offering_name": "Cloud VM Service",
    "checklist_name": "Security Compliance Checklist",
    "username": "janesmith",
    "state": "OK",
    "completion_percentage": 50,
    "compliance_status": "pending",
    "last_updated": "2024-01-18T14:20:00Z",
    "created": "2024-01-10T11:00:00Z"
  }
]

Workflow Examples

Complete User Compliance Flow

  1. Check if offering requires compliance
1
GET /api/marketplace-public-offerings/<offering-uuid>/

Check the has_compliance_requirements field in the response.

  1. User receives offering access

  2. When an offering user is created for an offering with compliance requirements, a compliance checklist completion is automatically created

  3. User views compliance requirements (only if has_compliance_requirements is true)

1
GET /api/marketplace-offering-users/<uuid>/checklist/
  1. User submits compliance answers
1
POST /api/marketplace-offering-users/<uuid>/submit_answers/
  1. Service provider monitors compliance
1
GET /api/marketplace-service-providers/<uuid>/compliance/compliance_overview/

Service Provider Monitoring Flow

  1. View overall compliance statistics
1
GET /api/marketplace-service-providers/<uuid>/compliance/compliance_overview/
  1. Identify non-compliant users
1
GET /api/marketplace-service-providers/<uuid>/compliance/offering_users/?compliance_status=pending
  1. Follow up with specific users

Use the user details from the response to send reminders or take action

Lifecycle Management

Automatic Checklist Creation

When an offering user is created:

  1. System checks if the offering has a compliance checklist
  2. If present, creates a ChecklistCompletion object automatically
  3. Links it to the offering user via generic foreign key

Automatic Cleanup

When an offering user is deleted:

  1. Associated ChecklistCompletion is automatically deleted
  2. All related answers are cascade deleted
  3. No orphaned data remains

Error Handling

Common Error Responses

400 Bad Request - No Checklist Configured

1
2
3
{
  "detail": "No checklist configured for this object"
}

This occurs when trying to access compliance endpoints for an offering without a configured checklist.

403 Forbidden - Insufficient Permissions

1
2
3
{
  "detail": "You do not have permission to perform this action."
}

404 Not Found - Resource Not Found

1
2
3
{
  "detail": "Not found."
}

This can occur when:

  • The offering user doesn't exist
  • The service provider doesn't exist
  • The user doesn't have access to the resource

Validation Errors

When submitting invalid answers:

1
2
3
4
5
6
7
8
9
[
  {},  // First answer valid
  {
    "non_field_errors": [
      "Answer value 'invalid text' is not valid for the question 'Accept terms' (type: boolean)."
    ]
  },
  {}   // Third answer valid
]

Integration Patterns

Frontend Integration

When displaying offerings in your application, use the has_compliance_requirements field to show appropriate UI elements:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
// Example: React component for offering display
function OfferingCard({ offering }) {
  return (
    <div className="offering-card">
      <h3>{offering.name}</h3>
      <p>{offering.description}</p>

      {offering.has_compliance_requirements && (
        <div className="compliance-notice">
          <Icon name="shield" />
          <span>Compliance requirements apply</span>
        </div>
      )}

      <button onClick={() => handleOrder(offering)}>
        Order Service
      </button>
    </div>
  );
}

Order Flow Integration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
// Example: Check compliance before allowing order completion
async function handleOfferingOrder(offering, user) {
  if (offering.has_compliance_requirements) {
    // Redirect to compliance checklist first
    const complianceStatus = await checkUserCompliance(offering, user);

    if (!complianceStatus.is_completed) {
      return redirectToCompliance(offering, user);
    }
  }

  // Proceed with normal order flow
  return processOrder(offering, user);
}

Service Provider Dashboard

Use the compliance overview endpoints to build monitoring dashboards:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// Example: Compliance dashboard component
function ComplianceDashboard({ serviceProvider }) {
  const [complianceData, setComplianceData] = useState([]);

  useEffect(() => {
    fetch(`/api/marketplace-service-providers/${serviceProvider.uuid}/compliance/compliance_overview/`)
      .then(response => response.json())
      .then(data => setComplianceData(data));
  }, [serviceProvider.uuid]);

  return (
    <div className="compliance-dashboard">
      {complianceData.map(offering => (
        <div key={offering.offering_uuid} className="offering-compliance">
          <h4>{offering.offering_name}</h4>
          {offering.checklist_name ? (
            <div className="compliance-stats">
              <span>Compliance Rate: {offering.compliance_rate}%</span>
              <span>Pending Users: {offering.pending_users}</span>
            </div>
          ) : (
            <span className="no-compliance">No compliance requirements</span>
          )}
        </div>
      ))}
    </div>
  );
}

Best Practices

For Service Providers

  1. Define Clear Questions
  2. Use descriptive question text
  3. Mark truly required fields as required

  4. Provide helpful guidance text where needed

  5. Regular Monitoring

  6. Check compliance overview regularly
  7. Follow up with users who have pending compliance

  8. Consider setting up automated reminders

  9. Checklist Design

  10. Keep checklists concise and relevant
  11. Group related questions logically
  12. Use appropriate question types for each data point

For Developers

  1. Performance Optimization
  2. Use the has_compliance_requirements field to avoid unnecessary API calls
  3. Use the compliance_overview endpoint for dashboard views
  4. Apply filters to reduce data transfer

  5. Cache compliance status where appropriate

  6. Error Handling

  7. Always check has_compliance_requirements before accessing compliance endpoints
  8. Handle gracefully when compliance endpoints return 400 (no checklist configured)
  9. Handle permission errors gracefully

  10. Provide clear feedback to users

  11. Integration

  12. Check has_compliance_requirements in offering lists to show UI indicators
  13. Only call compliance endpoints when has_compliance_requirements is true
  14. Consider webhooks for compliance completion events
  15. Integrate with notification systems for reminders
  16. Build dashboards using the overview endpoints

Migration Guide

Adding Compliance to Existing Offerings

  1. Create the compliance checklist
  2. Update the offering with the checklist UUID
  3. Existing offering users will need to complete compliance
  4. New offering users will get compliance requirements automatically

Removing Compliance Requirements

  1. Set offering's compliance_checklist to null
  2. Existing completions remain for audit purposes
  3. No new completions will be created

Security Considerations

  1. Data Privacy
  2. Compliance data is only visible to authorized users
  3. Service providers can only see data for their own offerings

  4. Users can only see and edit their own compliance data

  5. Audit Trail

  6. All answer submissions are tracked with timestamps
  7. User information is preserved with each answer

  8. Changes are logged for compliance auditing

  9. Permission Model

  10. Based on existing Waldur permission system
  11. Respects customer and project boundaries
  12. Service provider permissions are strictly scoped

Project Metadata API Documentation

Project metadata functionality allows organizations to collect structured information about their projects using customizable checklists. This feature is built on top of the core checklist system and provides a standardized way to gather project details, compliance information, and other metadata.

Overview

Project metadata uses the checklist system to enable organizations to:

  • Define custom metadata collection forms for their projects
  • Ensure consistent data collection across all projects
  • Track completion status of metadata requirements
  • Manage access controls for viewing and editing metadata

Configuration

Setting Up Project Metadata

  1. Create a Project Metadata Checklist

First, create a checklist with type PROJECT_METADATA:

1
2
3
4
5
6
7
8
9
POST /api/checklists-admin/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "name": "Project Metadata Collection",
  "description": "Standard metadata required for all projects",
  "checklist_type": "PROJECT_METADATA"
}
  1. Add Questions to the Checklist
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /api/checklists-admin/questions/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "checklist": "<checklist-uuid>",
  "description": "Project purpose",
  "question_type": "text_area",
  "required": true,
  "order": 1
}
  1. Assign Checklist to Customer

Assign the checklist to a customer to enable metadata collection for all their projects:

1
2
3
4
5
6
7
PATCH /api/customers/<customer-uuid>/
Content-Type: application/json
Authorization: Token <admin-token>

{
  "project_metadata_checklist": "<checklist-uuid>"
}

API Endpoints

Project metadata endpoints are available at both project and customer levels:

Project-Level Endpoints

Base URL: /api/projects/<project-uuid>/

Customer-Level Compliance Endpoints

Base URL: /api/customers/<customer-uuid>/

These endpoints provide aggregated compliance information across all projects in a customer organization. All endpoints support efficient database-level pagination to handle large numbers of projects.

Customer-Level Compliance Overview

Get an overview of project metadata compliance across all customer projects.

1
2
GET /api/customers/<customer-uuid>/project-metadata-compliance-overview/
Authorization: Token <token>

Permissions Required:

  • Customer owner
  • Customer support
  • Staff user

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "checklist_configured": true,
  "checklist": {
    "uuid": "checklist-uuid",
    "name": "Project Metadata Collection",
    "description": "Standard metadata required for all projects"
  },
  "total_projects": 25,
  "projects_with_completion": 20,
  "projects_without_completion": 5,
  "average_completion_percentage": 75.5,
  "fully_completed_projects": 15,
  "partially_completed_projects": 5,
  "not_started_projects": 5
}

Customer-Level Compliance Projects List

Get paginated list of projects with their completion status.

1
2
GET /api/customers/<customer-uuid>/project-metadata-compliance-projects/
Authorization: Token <token>

Query Parameters:

  • page - Page number (default: 1)
  • page_size - Number of projects per page (default: 10, max: 300)

Permissions Required:

  • Customer owner
  • Customer support
  • Staff user

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {
    "uuid": "project-uuid-1",
    "name": "AI Research Project",
    "completion_uuid": "completion-uuid-1",
    "completion_percentage": 100.0,
    "is_completed": true,
    "unanswered_required_questions": 0
  },
  {
    "uuid": "project-uuid-2",
    "name": "Development Project",
    "completion_uuid": "completion-uuid-2",
    "completion_percentage": 66.7,
    "is_completed": false,
    "unanswered_required_questions": 1
  }
]

Response Headers:

  • X-Result-Count - Total number of projects
  • Link - Pagination links (first, prev, next, last)

Customer-Level Question Answers

Get paginated list of questions with answers across all projects.

1
2
GET /api/customers/<customer-uuid>/project-metadata-question-answers/
Authorization: Token <token>

Query Parameters:

  • page - Page number (default: 1)
  • page_size - Number of questions per page (default: 10, max: 300)

Permissions Required:

  • Customer owner
  • Customer support
  • Staff user

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
[
  {
    "uuid": "question-uuid-1",
    "description": "Project purpose",
    "question_type": "text_area",
    "required": true,
    "order": 1,
    "question_options": [],
    "projects_with_answers": [
      {
        "project_uuid": "project-uuid-1",
        "project_name": "AI Research Project",
        "answer_data": "Research project for AI development",
        "answer_labels": null,
        "user_name": "John Doe",
        "created": "2024-01-15T14:20:00Z",
        "modified": "2024-01-15T14:20:00Z"
      },
      {
        "project_uuid": "project-uuid-2",
        "project_name": "Development Project",
        "answer_data": "Software development project",
        "answer_labels": null,
        "user_name": "Jane Smith",
        "created": "2024-01-16T10:30:00Z",
        "modified": "2024-01-16T10:30:00Z"
      }
    ]
  },
  {
    "uuid": "question-uuid-2",
    "description": "Project category",
    "question_type": "single_select",
    "required": false,
    "order": 2,
    "question_options": [
      {
        "uuid": "option-uuid-1",
        "label": "Research",
        "order": 1
      },
      {
        "uuid": "option-uuid-2",
        "label": "Development",
        "order": 2
      }
    ],
    "projects_with_answers": [
      {
        "project_uuid": "project-uuid-1",
        "project_name": "AI Research Project",
        "answer_data": ["option-uuid-1"],
        "answer_labels": "Research",
        "user_name": "John Doe",
        "created": "2024-01-15T14:25:00Z",
        "modified": "2024-01-15T14:25:00Z"
      }
    ]
  }
]

Response Headers:

  • X-Result-Count - Total number of questions
  • Link - Pagination links (first, prev, next, last)

Enhanced Fields:

Each question and its answers now include additional metadata for better usability:

  • question_options - Available options for select-type questions (single_select, multi_select), empty array for other types
  • answer_labels - Human-readable labels for select-type answers:
  • For single_select: String with the selected option label
  • For multi_select: Array of strings with selected option labels
  • For other question types: null
  • min_value - Minimum allowed value for number-type questions, null for other question types
  • max_value - Maximum allowed value for number-type questions, null for other question types

Customer-Level Compliance Details

Get paginated detailed compliance information for each project.

1
2
GET /api/customers/<customer-uuid>/project-metadata-compliance-details/
Authorization: Token <token>

Query Parameters:

  • page - Page number (default: 1)
  • page_size - Number of projects per page (default: 10, max: 300)

Permissions Required:

  • Customer owner
  • Customer support
  • Staff user

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
[
  {
    "project": {
      "uuid": "project-uuid-1",
      "name": "AI Research Project"
    },
    "completion": {
      "uuid": "completion-uuid-1",
      "is_completed": true,
      "completion_percentage": 100.0,
      "created": "2024-01-15T10:30:00Z",
      "modified": "2024-01-15T15:45:00Z"
    },
    "answers": [
      {
        "question_uuid": "question-uuid-1",
        "question_description": "Project purpose",
        "question_type": "text_area",
        "min_value": null,
        "max_value": null,
        "question_options": [],
        "answer_data": "Research project for AI development",
        "answer_labels": null,
        "user_name": "John Doe",
        "created": "2024-01-15T14:20:00Z",
        "modified": "2024-01-15T14:20:00Z"
      },
      {
        "question_uuid": "question-uuid-2",
        "question_description": "Project category",
        "question_type": "single_select",
        "min_value": null,
        "max_value": null,
        "question_options": [
          {
            "uuid": "option-uuid-1",
            "label": "Research",
            "order": 1
          },
          {
            "uuid": "option-uuid-2",
            "label": "Development",
            "order": 2
          }
        ],
        "answer_data": ["option-uuid-1"],
        "answer_labels": "Research",
        "user_name": "John Doe",
        "created": "2024-01-15T14:25:00Z",
        "modified": "2024-01-15T14:25:00Z"
      },
      {
        "question_uuid": "question-uuid-3",
        "question_description": "Project budget (in millions)",
        "question_type": "number",
        "min_value": "0.1000",
        "max_value": "100.0000",
        "question_options": [],
        "answer_data": 5.0,
        "answer_labels": null,
        "user_name": "John Doe",
        "created": "2024-01-15T14:30:00Z",
        "modified": "2024-01-15T14:30:00Z"
      }
    ],
    "unanswered_required_questions": []
  }
]

Response Headers:

  • X-Result-Count - Total number of projects
  • Link - Pagination links (first, prev, next, last)

Answer Fields Description:

Each answer in the response includes both machine-readable and human-readable data:

  • question_type - The type of question (text_input, text_area, boolean, number, single_select, multi_select)
  • question_options - Available options for select-type questions, empty array for other types
  • min_value - Minimum allowed value for number-type questions, null for other question types
  • max_value - Maximum allowed value for number-type questions, null for other question types
  • answer_data - The raw answer data (UUIDs for select questions, direct values for others)
  • answer_labels - Human-readable labels converted from UUIDs:
  • For single_select: String with the selected option label
  • For multi_select: Array of strings with selected option labels
  • For other question types: null

Performance Notes

All customer-level compliance endpoints use database-level pagination for optimal performance:

  • Efficient Data Loading: Only retrieves data for the current page, not all records
  • Bulk Operations: Uses optimized database queries with select_related() and prefetch_related()
  • Memory Efficient: Handles large numbers of projects without memory issues
  • Pagination Headers: Returns X-Result-Count header with total count and Link header with navigation links

Available Actions

1. Get Project Metadata Checklist

Retrieves the metadata checklist for a project, including all questions and existing answers.

1
2
GET /api/projects/<project-uuid>/checklist/
Authorization: Token <token>

Permissions Required:

  • Project member (admin, manager, or member)
  • Customer owner

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "checklist": {
    "uuid": "checklist-uuid",
    "name": "Project Metadata Collection",
    "description": "Standard metadata required for all projects",
    "checklist_type": "PROJECT_METADATA"
  },
  "completion": {
    "uuid": "completion-uuid",
    "is_completed": false,
    "completion_percentage": 33.3,
    "unanswered_required_questions": [
      {
        "uuid": "question-uuid",
        "description": "Project budget",
        "question_type": "number"
      }
    ],
    "checklist_name": "Project Metadata Collection",
    "checklist_description": "Standard metadata required for all projects",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-15T14:20:00Z"
  },
  "questions": [
    {
      "uuid": "question-uuid",
      "description": "Project purpose",
      "question_type": "text_area",
      "required": true,
      "order": 1,
      "existing_answer": {
        "uuid": "answer-uuid",
        "answer_data": "Research project for AI development",
        "user": "user-uuid",
        "user_name": "John Doe",
        "created": "2024-01-15T14:20:00Z",
        "modified": "2024-01-15T14:20:00Z"
      },
      "question_options": []
    },
    {
      "uuid": "question-uuid-2",
      "description": "Project category",
      "question_type": "single_select",
      "required": true,
      "order": 2,
      "existing_answer": null,
      "question_options": [
        {
          "uuid": "option-uuid-1",
          "label": "Research",
          "order": 1
        },
        {
          "uuid": "option-uuid-2",
          "label": "Development",
          "order": 2
        }
      ]
    }
  ]
}

2. Get Completion Status

Retrieves only the completion status information for the project metadata.

1
2
GET /api/projects/<project-uuid>/completion_status/
Authorization: Token <token>

Permissions Required:

  • Project member (admin, manager, or member)
  • Customer owner

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "uuid": "completion-uuid",
  "is_completed": false,
  "completion_percentage": 66.7,
  "unanswered_required_questions": [
    {
      "uuid": "question-uuid",
      "description": "Project budget",
      "question_type": "number"
    }
  ],
  "checklist_name": "Project Metadata Collection",
  "checklist_description": "Standard metadata required for all projects",
  "created": "2024-01-15T10:30:00Z",
  "modified": "2024-01-15T14:20:00Z"
}

3. Submit Metadata Answers

Submit or update answers to metadata questions.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
POST /api/projects/<project-uuid>/submit_answers/
Content-Type: application/json
Authorization: Token <token>

[
  {
    "question_uuid": "question-uuid-1",
    "answer_data": "This is a research project for machine learning applications"
  },
  {
    "question_uuid": "question-uuid-2",
    "answer_data": true
  },
  {
    "question_uuid": "question-uuid-3",
    "answer_data": ["option-uuid-1"]
  },
  {
    "question_uuid": "question-uuid-4",
    "answer_data": ["option-uuid-2", "option-uuid-3"]
  }
]

Permissions Required:

  • Customer owner
  • Project manager

Answer Data Formats:

Question Type Format Example
text_input String "Short text answer"
text_area String "Long text answer with multiple lines"
boolean Boolean true or false
number Number 42 or 3.14
single_select Array with one UUID ["option-uuid"]
multi_select Array with multiple UUIDs ["option-uuid-1", "option-uuid-2"]

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "detail": "Answers submitted successfully",
  "completion": {
    "uuid": "completion-uuid",
    "is_completed": true,
    "completion_percentage": 100.0,
    "unanswered_required_questions": [],
    "checklist_name": "Project Metadata Collection",
    "checklist_description": "Standard metadata required for all projects",
    "created": "2024-01-15T10:30:00Z",
    "modified": "2024-01-15T15:45:00Z"
  }
}

Error Responses

Common Error Codes

400 Bad Request

1
2
3
{
  "detail": "No checklist configured for this object"
}

403 Forbidden

1
2
3
{
  "detail": "You do not have permission to perform this action."
}

404 Not Found

1
2
3
{
  "detail": "Not found."
}

Validation Errors

When submitting invalid answers:

1
2
3
4
5
6
7
8
9
[
  {},  // First answer valid
  {
    "non_field_errors": [
      "Answer value 'invalid' is not valid for the question 'Project category' (type: single_select)."
    ]
  },  // Second answer invalid
  {}   // Third answer valid
]

Permission Model

The project metadata system uses a granular permission model:

View Permissions (checklist, completion_status)

  • Project Admin: Can view metadata for their projects
  • Project Manager: Can view metadata for their projects
  • Project Member: Can view metadata for their projects
  • Customer Owner: Can view metadata for all projects in their organization

Update Permissions (submit_answers)

  • Customer Owner: Can update metadata for all projects in their organization
  • Project Manager: Can update metadata for their projects

Administrative Permissions (checklist management)

  • Staff Users: Can create and manage checklists
  • Customer Owners: Can assign checklists to their organization

Lifecycle Management

Automatic Checklist Completion Creation

When a customer has a project metadata checklist configured:

  1. New Project Creation: ChecklistCompletion is automatically created for new projects
  2. Existing Projects: ChecklistCompletion is created for all existing projects when checklist is assigned
  3. Checklist Removal: All associated ChecklistCompletions are automatically deleted

Data Integrity

  • Answers are tied to the user who submitted them
  • Multiple users can provide answers to the same checklist
  • Answer history is maintained with creation and modification timestamps
  • Completion status is calculated in real-time based on required questions

Best Practices

For API Consumers

  1. Check Completion Status: Always check if metadata is required before showing forms
  2. Handle Missing Checklists: Gracefully handle cases where no checklist is configured
  3. Validate Before Submit: Validate answer formats client-side to reduce API errors
  4. Show Progress: Use completion_percentage to show users their progress
  5. Cache Appropriately: Checklist structure changes infrequently, status changes often
  6. Use Customer-Level Endpoints: For organizational dashboards, use customer-level compliance endpoints for efficient aggregated views
  7. Leverage Pagination: Take advantage of database-level pagination for large datasets with appropriate page sizes
  8. Use Enhanced Fields: Take advantage of enhanced question metadata for better user experience:
  9. Display question_options to show available choices for select questions
  10. Use answer_labels for human-readable display while keeping answer_data for form submissions
  11. Use min_value and max_value for client-side validation of number inputs
  12. All enhanced fields are optimized to avoid N+1 query issues

For Administrators

  1. Plan Question Structure: Design questions before creating projects
  2. Use Clear Descriptions: Make question descriptions self-explanatory
  3. Set Appropriate Requirements: Mark essential questions as required
  4. Test Thoroughly: Test the complete flow before deploying to users
  5. Monitor Adoption: Track completion rates to ensure effective use

Release Orchestration

This document describes the automated release orchestration system that coordinates releases across the entire Waldur ecosystem from the waldur-docs repository.

Overview

The waldur-docs repository serves as the central orchestration hub for Waldur releases. When a semantic version tag (e.g., 7.6.8) is applied to this repository, it triggers an automated workflow that:

  1. Updates documentation with versioned API schemas and changelogs
  2. Tags all repositories across the Waldur ecosystem
  3. Updates version references in deployment configurations
  4. Releases SDKs with updated version numbers
  5. Generates comprehensive changelogs with cross-repository links

Release flow diagram

flowchart TD
  A[Create semantic version tag<br/>on waldur-docs] --> B{GitLab CI pipeline<br/>triggered}

  B --> C[Test stage]
  C --> C1[Lint markdown files]
  C --> C2[Test MkDocs build]
  C --> C3[Test Docker Compose<br/>deployment]
  C --> C4[Test Helm<br/>deployment]
  C --> C5[Test changelog<br/>generation]

  C1 --> D{All tests pass?}
  C2 --> D
  C3 --> D
  C4 --> D
  C5 --> D

  D -->|No| E[Pipeline fails]
  D -->|Yes| F[Deploy stage]

  F --> F1[Build & deploy<br/>documentation]
  F --> F2[Tag all repositories]
  F --> F3[Release SDKs]
  F --> F4[Update configurations]
  F --> F5[Generate changelog]

  F1 --> F1a[Deploy latest docs<br/>to GitHub Pages]
  F1 --> F1b[Deploy tagged version<br/>with mike]

  F2 --> F2a[waldur-mastermind]
  F2 --> F2b[waldur-homeport]
  F2 --> F2c[waldur-prometheus-exporter]

  F3 --> F3a[Python SDK<br/>update pyproject.toml]
  F3 --> F3b[JS/TS SDK<br/>update package.json]
  F3 --> F3c[Go SDK<br/>git tag only]

  F4 --> F4a[Helm charts<br/>update Chart.yaml & values.yaml]
  F4 --> F4b[Docker Compose<br/>update .env.example]

  F5 --> F5a[Parse previous version<br/>from CHANGELOG.md]
  F5 --> F5b[Generate diff links<br/>for all repos]
  F5 --> F5c[Add SBOM & API<br/>schema references]
  F5 --> F5d[Commit updated<br/>changelog]

  F1a --> G[Release complete]
  F1b --> G
  F2a --> G
  F2b --> G
  F2c --> G
  F3a --> G
  F3b --> G
  F3c --> G
  F4a --> G
  F4b --> G
  F5d --> G

  G --> H[Post-deploy stage]
  H --> H1[Deploy tagged<br/>documentation]

  style A fill:#e1f5fe
  style G fill:#c8e6c9
  style E fill:#ffcdd2
  style F fill:#fff3e0

Coordinated repositories

The release orchestration manages the following repositories:

Core components

  • waldur-mastermind - Backend API and business logic
  • waldur-homeport - Frontend web application
  • waldur-prometheus-exporter - Metrics and monitoring

Deployment & infrastructure

  • waldur-helm - Kubernetes Helm charts
  • waldur-docker-compose - Docker Compose configurations

SDKs & client libraries

  • py-client - Python SDK
  • js-client - TypeScript/JavaScript SDK
  • go-client - Go SDK

Release workflow

1. Pre-release testing

Before creating a release tag, the system validates:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Triggered on semantic version tags
Test Docker Compose deployment before tagging:
  rules:
    - if: '$CI_COMMIT_TAG =~ /^\d+\.\d+\.\d+$/'
  trigger: waldur/waldur-docker-compose

Test Helm deployment before tagging:
  rules:
    - if: '$CI_COMMIT_TAG =~ /^\d+\.\d+\.\d+$/'
  trigger: waldur/waldur-helm

2. Repository tagging

The system automatically tags all core repositories with the same version:

1
2
3
4
# Each repository is cloned, tagged, and pushed
git clone "https://gitlab-ci-token:$GITLAB_TOKEN@$CI_SERVER_HOST/waldur/waldur-mastermind.git"
git tag -a $CI_COMMIT_TAG -m "$CI_COMMIT_TAG_MESSAGE"
git push origin $CI_COMMIT_TAG

3. Configuration updates

Helm charts

Version numbers are updated in Chart.yaml and values.yaml:

1
2
3
sed -i -E "s/^version: ('.*'|.*)$/version: $CI_COMMIT_TAG/" waldur/Chart.yaml
sed -i -E "s/^appVersion: ('.*'|.*)$/appVersion: \"$CI_COMMIT_TAG\"/" waldur/Chart.yaml
sed -i -E "s/^  imageTag: ('.*'|.*)$/  imageTag: \"$CI_COMMIT_TAG\"/" waldur/values.yaml

Docker Compose

Image tags are updated in .env.example:

1
2
sed -i -E "s/^WALDUR_MASTERMIND_IMAGE_TAG=('.*'|.*)$/WALDUR_MASTERMIND_IMAGE_TAG=$CI_COMMIT_TAG/" .env.example
sed -i -E "s/^WALDUR_HOMEPORT_IMAGE_TAG=('.*'|.*)$/WALDUR_HOMEPORT_IMAGE_TAG=$CI_COMMIT_TAG/" .env.example

4. SDK releases

Python SDK

Updates pyproject.toml with new version:

1
sed -i 's/^version = "[^"]*"/version = "'$CI_COMMIT_TAG'"/' pyproject.toml

JavaScript/TypeScript SDK

Updates both package.json and package-lock.json:

1
2
sed -i 's/"version": "[^"]*"/"version": "'$CI_COMMIT_TAG'"/' package.json
# Complex package-lock.json updates for multiple version references

Go SDK

Simple tag-based versioning (Go modules use git tags for versions).

5. Changelog generation

The system automatically generates comprehensive changelogs that include:

1
2
* Waldur MasterMind: [tag diff](https://github.com/waldur/waldur-mastermind/compare/7.6.7...7.6.8)
* Waldur HomePort: [tag diff](https://github.com/waldur/waldur-homeport/compare/7.6.7...7.6.8)

Security & compliance artifacts

1
2
3
4
* Image SBOM: [waldur-mastermind-7.6.8-image.cyclonedx.tar.gz](...)
* Source SBOM: [waldur-mastermind-7.6.8-source.cyclonedx.tar.gz](...)
* OpenAPI specification: [waldur-openapi-schema-7.6.8.yaml](...)
* API changes: [View changes](/latest/integrator-guide/APIs/api-changes/waldur-openapi-schema-7.6.8-diff)

Documentation versioning

Version-specific documentation

The system deploys versioned documentation using mike:

1
2
3
4
5
# Latest version (from master branch)
mike deploy latest -p -r github_waldur -b gh-pages

# Tagged versions
mike deploy $CI_COMMIT_TAG -p -r github_waldur -b gh-pages

API schema management

Each release includes:

  • Versioned OpenAPI schema - waldur-openapi-schema-{version}.yaml
  • API diff reports - Comparing changes between versions
  • SBOM files - Software Bill of Materials for security compliance

Release process

For maintainers

  1. Prepare the release by ensuring all component repositories are ready
  2. Create a semantic version tag on waldur-docs repository:
1
2
git tag -a 7.6.9 -m "Release 7.6.9: Description of changes"
git push origin 7.6.9
  1. Monitor the pipeline - GitLab CI will automatically:
  2. Test deployment configurations
  3. Tag all repositories
  4. Update configuration files
  5. Release SDKs
  6. Generate changelogs
  7. Deploy documentation

Validation

The release is complete when: - [ ] All repositories have the new tag - [ ] Helm chart versions are updated - [ ] Docker Compose configurations reference new image tags - [ ] SDK packages are released with new versions - [ ] Documentation is deployed with the new version - [ ] Changelog is updated with comprehensive links

Emergency procedures

Rolling back a release

If a release needs to be rolled back:

  1. Remove the git tag from all repositories
  2. Revert configuration changes in helm and docker-compose repositories
  3. Update documentation to remove the problematic version
  4. Coordinate with package repositories (PyPI, npm) if SDKs were published

Partial release recovery

If only some repositories were tagged successfully:

  1. Identify missing tags by checking each repository
  2. Manually tag missing repositories using the same tag message
  3. Re-run failed CI jobs if configuration updates are missing

Security considerations

  • SSH keys for GitHub authentication are stored as GitLab CI variables
  • GitLab tokens provide access to private repositories
  • SBOM generation ensures supply chain security compliance
  • Automated testing validates deployments before release completion

Settings policy

Settings are used to configure behaviour of Waldur deployment. Settings can be used for configuration of both core and plugins, or dependent libraries.

Below is a policy for the settings.

Plugin settings

Plugins are defining their settings in the extension.py. However, most probably not all settings might make sense to override in production. Responsibility for highlighting what settings could be overridden in production are on plugin developer.

Deployment settings

Deployment specific settings (e.g. for CentOS-8) are maintained as Python files and are kept in /etc/waldur/:

  • override.conf.py - all settings overwritten for the deployment apart from logging settings;
  • features.json - features setup for frontend;
  • logging.conf.py - logging configuration for Waldur

Waldur Support Module

The Support module provides a comprehensive helpdesk and ticketing system with multi-backend integration, enabling organizations to manage support requests through JIRA, SMAX, Zammad, or a basic built-in system.

Overview

The support module acts as an abstraction layer over multiple ticketing backends, providing:

  • Unified API for ticket management across different backends
  • Bidirectional synchronization with external ticketing systems
  • Template-based issue creation
  • Customer feedback collection
  • SLA tracking and reporting
  • Advanced permission management

Architecture

graph TB
    subgraph "Waldur Support"
        API[Support API]
        Models[Support Models]
        Backend[Backend Interface]
    end

    subgraph "External Systems"
        JIRA[JIRA/Service Desk]
        SMAX[Micro Focus SMAX]
        Zammad[Zammad]
    end

    subgraph "Integration"
        Webhook[Webhooks]
        Sync[Synchronization]
    end

    API --> Models
    Models --> Backend
    Backend --> JIRA
    Backend --> SMAX
    Backend --> Zammad

    JIRA --> Webhook
    SMAX --> Webhook
    Zammad --> Webhook
    Webhook --> Models

    Sync --> Backend

Core Components

1. Issue Management

The Issue model is the central entity for ticket management:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class Issue:
    # Identification
    key: str              # Backend ticket ID (e.g., "PROJ-123")
    backend_id: str       # Internal backend ID
    summary: str          # Issue title
    description: str      # Detailed description

    # Classification
    type: str            # INFORMATIONAL, SERVICE_REQUEST, CHANGE_REQUEST, INCIDENT
    status: str          # Backend-specific status
    priority: Priority   # Priority level

    # Relationships
    caller: User         # Waldur user who created the issue
    reporter: SupportUser # Backend user who reported
    assignee: SupportUser # Backend user assigned
    customer: Customer   # Associated customer
    project: Project     # Associated project
    resource: GenericFK  # Linked resource (VM, network, etc.)

    # SLA & Timing
    created: datetime
    modified: datetime
    deadline: datetime
    first_response_sla: datetime
    resolution_date: datetime

Issue Types:

  • INFORMATIONAL - General information requests
  • SERVICE_REQUEST - Service provisioning requests
  • CHANGE_REQUEST - Change management requests
  • INCIDENT - Incident reports and outages

2. Comment System

Comments provide threaded discussions on issues:

1
2
3
4
5
6
class Comment:
    issue: Issue         # Parent issue
    description: str     # Comment text
    author: SupportUser  # Comment author
    is_public: bool      # Visibility control
    backend_id: str      # Backend comment ID

Comment Features:

  • Public/private visibility control
  • Automatic user information formatting for backends
  • Bidirectional synchronization

3. Attachment Management

File attachments for issues and templates:

1
2
3
4
5
6
7
8
class Attachment:
    issue: Issue
    file: FileField     # Stored in 'support_attachments/'
    backend_id: str     # Backend attachment ID

    # Properties from FileMixin
    mime_type: str
    file_size: int

4. User Management

SupportUser bridges Waldur users with backend systems:

1
2
3
4
5
6
class SupportUser:
    user: User          # Waldur user (optional)
    name: str           # Display name
    backend_id: str     # Backend user ID
    backend_name: str   # Backend type
    is_active: bool     # Activity status

5. Template System

Templates enable standardized issue creation:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
class Template:
    name: str
    description: str
    issue_type: str     # Issue classification

class TemplateConfirmationComment:
    template: Template
    comment: str        # Auto-response text

class TemplateStatusNotification:
    template: Template
    status: str         # Trigger status
    html_template: str  # Email template

6. Status Management

IssueStatus maps backend statuses to resolution types:

1
2
3
4
5
6
7
8
class IssueStatus:
    uuid: UUID          # Unique identifier
    name: str           # Backend status name (e.g., "Done", "Closed", "Cancelled")
    type: int           # RESOLVED or CANCELED

    # Types
    RESOLVED = 0        # Successfully completed
    CANCELED = 1        # Failed or canceled

Status Configuration:

Status configuration is critical for proper issue resolution detection. The system uses IssueStatus entries to determine whether an issue has been successfully resolved or canceled:

  • RESOLVED: Statuses that indicate successful completion (e.g., "Done", "Resolved", "Completed")
  • CANCELED: Statuses that indicate cancellation or failure (e.g., "Cancelled", "Rejected", "Failed")

Management Access:

  • Staff users: Full CRUD access to manage status configurations
  • Support users: Read-only access to view existing statuses
  • Regular users: No access

API Operations:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# List all issue statuses
GET /api/support-issue-statuses/

# Create new status (staff only)
POST /api/support-issue-statuses/
{
  "name": "In Progress",
  "type": 0
}

# Update existing status (staff only)
PATCH /api/support-issue-statuses/{uuid}/
{
  "name": "Completed"
}

# Delete status (staff only)
DELETE /api/support-issue-statuses/{uuid}/

7. Feedback System

Customer satisfaction tracking:

1
2
3
4
class Feedback:
    issue: Issue
    evaluation: int     # 1-10 scale
    comment: str        # Optional feedback text

Backend Integration

Supported Backends

1. JIRA/Atlassian Service Desk

Full-featured integration with:

  • Service Desk project support
  • Request type management
  • Customer portal integration
  • Webhook support for real-time updates
  • Custom field mapping

2. Micro Focus SMAX

Enterprise ITSM integration:

  • Request and incident management
  • Change management workflows
  • Service catalog integration
  • REST API-based synchronization
  • Webhook support for real-time updates

3. Zammad

Open-source ticketing system:

  • Multi-channel support (email, web, phone)
  • Customer organization management
  • Tag-based categorization
  • Webhook integration

4. Basic Backend

No-op implementation for:

  • Development and testing
  • Environments without external ticketing
  • Minimal support requirements

Backend Interface

All backends implement the SupportBackend interface:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class SupportBackend:
    # Issue operations
    def create_issue(issue: Issue) -> Issue
    def update_issue(issue: Issue) -> Issue
    def delete_issue(issue: Issue)
    def sync_issues(issue_id: Optional[str])

    # Comment operations
    def create_comment(comment: Comment) -> Comment
    def update_comment(comment: Comment) -> Comment
    def delete_comment(comment: Comment)

    # Attachment operations
    def create_attachment(attachment: Attachment) -> Attachment
    def delete_attachment(attachment: Attachment)

    # User management
    def pull_support_users()
    def get_or_create_support_user(backend_user) -> SupportUser

    # Configuration
    def pull_priorities()
    def pull_request_types()

API Endpoints

Issue Management

Endpoint Method Description
/api/support-issues/ GET List issues with filtering
/api/support-issues/ POST Create new issue
/api/support-issues/{uuid}/ GET Retrieve issue details
/api/support-issues/{uuid}/ PATCH Update issue
/api/support-issues/{uuid}/ DELETE Delete issue
/api/support-issues/{uuid}/comment/ POST Add comment to issue
/api/support-issues/{uuid}/sync/ POST Sync issue with backend

Comments

Endpoint Method Description
/api/support-comments/ GET List comments
/api/support-comments/{uuid}/ GET Retrieve comment
/api/support-comments/{uuid}/ PATCH Update comment
/api/support-comments/{uuid}/ DELETE Delete comment

Attachments

Endpoint Method Description
/api/support-attachments/ GET List attachments
/api/support-attachments/ POST Upload attachment
/api/support-attachments/{uuid}/ GET Download attachment
/api/support-attachments/{uuid}/ DELETE Delete attachment

Configuration & Management

Endpoint Method Description
/api/support-users/ GET List support users
/api/support-priorities/ GET List priorities
/api/support-templates/ GET/POST Manage templates
/api/support-feedback/ GET/POST Manage feedback
/api/support-issue-statuses/ GET/POST Manage issue statuses (staff only)
/api/support-issue-statuses/{uuid}/ GET/PATCH/DELETE Issue status details (staff only)

Webhooks

Endpoint Method Description
/api/support-jira-webhook/ POST JIRA webhook receiver
/api/support-smax-webhook/ POST SMAX webhook receiver
/api/support-zammad-webhook/ POST Zammad webhook receiver

Reports

Endpoint Method Description
/api/support-statistics/ GET Dashboard statistics
/api/support-feedback-report/ GET Feedback summary
/api/support-feedback-average-report/ GET Average ratings

Permissions

Permission Model

The support module uses Waldur's standard permission system with additional paths:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Issue permissions follow customer/project hierarchy
permission_paths = [
    'customer',
    'project',
    'project.customer',
]

# Role-based access
- Customer Owner: Full access to customer issues
- Project Admin: Full access to project issues
- Project Manager: Read/comment on project issues
- Staff/Support: Full system access

Filtering

Advanced filtering capabilities:

  • Customer/project-based filtering
  • Resource-based filtering (VMs, networks)
  • IP address lookup for resource issues
  • Full-text search across summary/description
  • Status, priority, and type filtering

Configuration

Django Settings

1
2
3
4
5
6
7
8
# Disable email notifications
WALDUR_SUPPORT['SUPPRESS_NOTIFICATION_EMAILS'] = True

# Enable feedback collection
WALDUR_SUPPORT['ISSUE_FEEDBACK_ENABLE'] = True

# Feedback token validity (days)
WALDUR_SUPPORT['ISSUE_FEEDBACK_TOKEN_PERIOD'] = 7

Constance Settings

Dynamic configuration via admin:

1
2
3
4
5
# Enable/disable support module
WALDUR_SUPPORT_ENABLED = True

# Select active backend
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE = 'atlassian'  # or 'zammad', 'smax', 'basic'

Backend Configuration

JIRA Configuration

1
2
3
4
5
6
7
8
WALDUR_SUPPORT['BACKEND'] = {
    'backend': 'waldur_mastermind.support.backend.atlassian.ServiceDeskBackend',
    'server': 'https://jira.example.com',
    'username': 'waldur-bot',
    'password': 'secret',
    'project_key': 'SUPPORT',
    'verify_ssl': True,
}

SMAX Configuration

1
2
3
4
5
6
7
WALDUR_SUPPORT['BACKEND'] = {
    'backend': 'waldur_mastermind.support.backend.smax.SmaxBackend',
    'api_url': 'https://smax.example.com/rest',
    'tenant_id': '12345',
    'user': 'integration-user',
    'password': 'secret',
}

Zammad Configuration

1
2
3
4
5
6
WALDUR_SUPPORT['BACKEND'] = {
    'backend': 'waldur_mastermind.support.backend.zammad.ZammadBackend',
    'api_url': 'https://zammad.example.com/api/v1',
    'token': 'api-token',
    'group': 'Support',
}

Workflows

Issue Creation Flow

sequenceDiagram
    participant User
    participant API
    participant Models
    participant Backend
    participant External

    User->>API: POST /support-issues/
    API->>Models: Create Issue
    Models->>Backend: create_issue()
    Backend->>External: Create ticket
    External-->>Backend: Ticket ID
    Backend-->>Models: Update backend_id
    Models-->>API: Issue created
    API-->>User: 201 Created

Synchronization Flow

sequenceDiagram
    participant Scheduler
    participant Backend
    participant External
    participant Models

    Scheduler->>Backend: sync_issues()
    Backend->>External: Fetch updates
    External-->>Backend: Issue data
    Backend->>Models: Update issues

    Note over Backend,Models: Update status, comments, attachments

    Backend->>Models: Process callbacks
    Note over Models: Trigger marketplace callbacks if needed

Webhook Flow

sequenceDiagram
    participant External
    participant Webhook
    participant Models
    participant Callbacks

    External->>Webhook: POST /support-*-webhook/
    Webhook->>Webhook: Validate signature
    Webhook->>Models: Update issue/comment

    alt Status changed
        Models->>Callbacks: Trigger callbacks
        Note over Callbacks: Resource state updates
    end

    Webhook-->>External: 200 OK

Celery Tasks

Scheduled background tasks:

Task Schedule Description
pull-support-users Every 6 hours Sync support users from backend
pull-priorities Daily at 1 AM Update priority levels
sync_request_types Daily at 1 AM Sync JIRA request types
sync-issues Configurable Full issue synchronization

Best Practices

1. Backend Selection

  • Use JIRA for enterprise environments with existing Atlassian infrastructure
  • Use SMAX for ITIL-compliant service management
  • Use Zammad for open-source, multi-channel support
  • Use Basic for development or minimal requirements

2. Status Configuration

  • Map all backend statuses: Create IssueStatus entries for every status that your backend can return
  • Define clear RESOLVED vs CANCELED mappings:
  • RESOLVED (type=0): Statuses indicating successful completion
  • CANCELED (type=1): Statuses indicating cancellation or failure
  • Use descriptive names: Match the exact status names from your backend system
  • Test status transitions: Verify resolution detection works correctly before production
  • Staff-only management: Only staff users can create/modify status configurations
  • Regular monitoring: Review status configurations when backend workflows change

3. Performance Optimization

  • Enable webhooks for real-time updates
  • Configure appropriate sync intervals
  • Use pagination for large issue lists
  • Implement caching for frequently accessed data

4. Security

  • Use secure webhook endpoints with signature validation
  • Implement proper permission checks
  • Sanitize user input in comments/descriptions
  • Use HTTPS for all backend connections

5. Monitoring

  • Monitor sync task execution
  • Track webhook delivery failures
  • Log backend API errors
  • Set up alerts for SLA breaches

Troubleshooting

Common Issues

1. Issues Not Syncing

  • Check backend connectivity
  • Verify API credentials
  • Review sync task logs
  • Ensure webhook configuration

2. Missing Status Updates

  • Verify IssueStatus configuration
  • Check webhook signature validation
  • Review backend field mappings
  • Monitor sync intervals

3. Permission Errors

  • Verify user roles and permissions
  • Check customer/project associations
  • Review permission paths configuration
  • Validate backend user permissions

4. Attachment Upload Failures

  • Check file size limits
  • Verify MIME type restrictions
  • Review storage permissions
  • Monitor backend API limits

Integration with Marketplace

The support module integrates with the marketplace for ticket-based offerings:

  1. Orders create support issues automatically
  2. Issue status changes trigger order callbacks
  3. Resolution status determines order success/failure
  4. Comments and attachments sync bidirectionally

See Ticket-Based Offerings Documentation for detailed marketplace integration.

Extension Points

The support module provides several extension points:

  1. Custom Backends: Implement SupportBackend interface
  2. Template Processors: Custom template variable processing
  3. Notification Handlers: Custom email/notification logic
  4. Webhook Processors: Custom webhook payload processing
  5. Feedback Collectors: Alternative feedback mechanisms

Appendix

Database Schema

Key database tables:

  • support_issue - Issue records
  • support_comment - Issue comments
  • support_attachment - File attachments
  • support_supportuser - Backend user mapping
  • support_priority - Priority levels
  • support_issuestatus - Status configuration (with UUID support)
  • support_template - Issue templates
  • support_feedback - Customer feedback

API Filters

Available query parameters:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
?customer=<uuid>           # Filter by customer
?project=<uuid>            # Filter by project
?status=<status>           # Filter by status
?priority=<uuid>           # Filter by priority
?type=<type>               # Filter by issue type
?caller=<uuid>             # Filter by caller
?assignee=<uuid>           # Filter by assignee
?created_after=<date>      # Created after date
?created_before=<date>     # Created before date
?search=<text>             # Full-text search
?resource=<uuid>           # Filter by resource
?o=<field>                 # Order by field

Error Codes

Common error responses:

Code Description
400 Invalid request data
401 Authentication required
403 Permission denied
404 Issue/resource not found
409 Conflict (duplicate, state issue)
424 Backend dependency failed
500 Internal server error

Templates

The content of this document is autogenerated during CI job execution.

Waldur CI/CD

General Architecture

Waldur uses CI/CD approach for testing, packaging and deployment. The approach is implemented with GitLab CI system. It provides a framework for building pipelines. A pipeline consists of a sequence of stages, each of which depends on the result of a predecessor and includes smaller parts called jobs. A job is a sequence of actions executed for a specific purpose, e.g., testing an application.

The entire CI/CD pipeline consists of smaller pipelines, each of which resides in a corresponding repository and belongs to a particular part.

The CI pipelines are created for the following modules:

  • Waldur Mastermind - REST API backend
  • Waldur Homeport - frontend module
  • Waldur Docker Compose - configuration for single-node deployment via Docker Compose
  • Waldur Helm Chart - package with templates of Kubernetes manifests for workload resources

The CD pipelines were created for several Waldur deployments like Waldur development or production.

The following diagram illustrates the general picture of the pipeline.

CI/CD Pipeline for Waldur

Pipeline architecture for Waldur Components

Waldur components are the separate applications of Waldur. The two major ones are Waldur Mastermind and Waldur Homeport.

Pipeline for Waldur Components

There are three main stages in the pipeline:

  • Test, where the source code lint and unit testing takes place. This stage runs for each commit in a merge request and for the main branch commits;
  • Build, where Docker image is being built. This stage runs for the main branch commits;
  • Release, where Docker image from the last stage is being published in Docker Hub registry. This stage runs for the main branch commits.

Pipeline architecture for Waldur Deployment Templates

Waldur deployment templates are the configurations for different deployment environments. Currently, Waldur supports Docker Compose and Kubernetes. The structure of the latter one is based on Helm technology. The pipeline is shown below.

Pipeline for Waldur Deployment Templates

This pipeline includes two stages:

  • Test, where the source code lint and configuration testing takes place. This stage runs for each commit in a merge request and the main branch commits;
  • Release, where the configuration is published to GitHub. This step is implemented with GitLab mirroring.

Pipeline architecture for Waldur Deployments

In this context, deployments are repositories with values for further insertion into Waldur Deployment Templates. For example, they can be values for environmental variables used in Waldur containers. The pipeline is shown below.

Pipeline for Waldur Deployments

There are three independent stages:

  • Deploy, where Waldur release is installed or updated. This stage runs only for main branch commits. For Docker Compose environment, this stage is triggered automatically. For Kubernetes, it runs automatically only for update operations, while installation requires a manual trigger. Also, the update action runs by a schedule, e.g. at 5 AM;
  • Test, where the running Waldur instance is tested. For example, it checks availability via HTTP requests sent to public Waldur endpoints;
  • Undeploy, which removes the Waldur instance. This stage can be triggered only manually.

Invoices plugin

Invoice price is calculated based on its items. For each object that should be added to invoice (invoice item source) should be created a separate model.

Business logic for invoice item creation and registration should be covered in a registrator in the module registrators.py.

Invoice items creation and termination should be triggered in handlers that reacts on items sources deletion or save. RegistrationManager should be used in handlers.

JIRA plugin

Configuration

  1. Define active backend.

    1
2
3
4
5
6
7
8
    # For Service Desk
WALDUR_SUPPORT.update({
    'ACTIVE_BACKEND': 'waldur_mastermind.support.backend.atlassian:ServiceDeskBackend',
})
# For JIRA
WALDUR_SUPPORT.update({
    'ACTIVE_BACKEND': 'waldur_mastermind.support.backend.atlassian:JiraBackend',
})

  2. Setup connection. Define server URL and user details to connect JIRA or Service Desk to Waldur:

    1
2
3
4
5
    WALDUR_SUPPORT['CREDENTIALS'].update({
    'server': <server URL>,
    'username': <Atlassian user username>,
    'password': <Atlassian user password>,
})

  3. Project setup. Define project key.

    1
2
3
    WALDUR_SUPPORT['PROJECT'].update({
    'key': <project key>,
})

  4. Project issues setup.

    4.1. Make sure that selected project supports registered types of issues: WALDUR_SUPPORT['ISSUE']['types'].

    4.2. Make sure that project issues have fields that corresponds to impact_field, reporter_field, caller_field. It is possible to override default field names:

1
2
3
4
5
WALDUR_SUPPORT['ISSUE'].update({
    'impact_field': <issue impact field name in JIRA or Service desk>,
    'reporter_field': <issue reporter field name in JIRA or Service desk>,
    'caller_field': <issue caller field name in JIRA or Service desk>,
})

Web hook installation

It's possible to track updates of JIRA issues and apply them to Waldur immediately.

An instruction of JIRA configuration can be found at https://developer.atlassian.com/jiradev/jira-apis/webhooks

Step by step guide:

  1. Log in to JIRA as administrator

  2. Click on a cogwheel in the upper right corner and pick 'System'.

  3. Scroll down to the lower left corner and find a "WebHook" option under the Advanced tab.

  4. Now click on "Create a Web Hook" You will be presented with a web hook creation view. There are only 3 mandatory fields - Name, Status and URL.

    4.1 Name your hook

    4.2 Select whether you want to enable it. It can be disabled at any moment from to the same menu.

    4.3 Configure a URL to send a POST request to. For instance: http://waldur.example.com/api/support-jira-webhook/ It is not needed to add any additional fields to request.

    *Note: In case of VirtualBox localhost usually is 10.0.2.2. So the complete URL will be next: http://10.0.2.2:8000/api/support-jira-webhook/*

    4.4 Add a description.

    4.5 Please make sure you've picked 'created, updated and deleted' actions under 'Events' section. No need to to check Comments events, they will be synced by the issue triggers.

    4.6 Save configuration.

OpenStack Replication Plugin

Introduction

The OpenStack Replication plugin extends Waldur's capabilities by enabling cross-tenant migration and replication of OpenStack infrastructure. This plugin allows organizations to migrate complete OpenStack tenants between different OpenStack service providers or regions while preserving network configurations, security groups, and other infrastructure components.

Core Functionality

The plugin enables:

  • Tenant Migration: Complete migration of OpenStack tenants between service providers
  • Network Replication: Copy network topologies, subnets, and routing configurations
  • Security Group Migration: Replicate security groups and their rules with proper references
  • Port Synchronization: Migrate port configurations including fixed IPs and security associations
  • Volume Type Mapping: Map volume types between source and destination environments
  • Quota Preservation: Maintain resource limits during migration
  • Selective Migration: Choose specific networks and resources to migrate

Architecture

Core Models

Migration

The central model that tracks migration operations between OpenStack tenants:

1
2
3
4
5
class Migration(TimeStampedModel, StateMixin, UuidMixin):
    created_by = ForeignKey(User)           # User who initiated migration
    src_resource = ForeignKey(Resource)     # Source marketplace resource
    dst_resource = ForeignKey(Resource)     # Destination marketplace resource
    mappings = JSONField()                  # Configuration mappings

Key Features:

  • State Tracking: Uses StateMixin for migration progress monitoring
  • User Attribution: Links migrations to specific users for auditing
  • Resource Linking: Connects source and destination marketplace resources
  • Flexible Mappings: JSON field stores complex migration configurations

Permissions: Only users who created migrations can access them

Migration Configuration

Mapping Options

The migration system supports flexible mapping configurations:

1
2
3
4
5
6
class MappingSerializer(serializers.Serializer):
    volume_types = VolumeTypeMappingSerializer(many=True)     # Volume type mappings
    subnets = SubNetMappingSerializer(many=True)             # Subnet CIDR mappings
    skip_connection_extnet = BooleanField(default=False)     # Skip external network connection
    sync_instance_ports = BooleanField(default=False)       # Enable port synchronization
    networks = SlugRelatedField(many=True)                  # Select specific networks

Volume Type Mapping:

  • Maps source volume types to destination equivalents
  • Preserves quota allocations across different storage backends
  • Validates that types exist in respective environments

Subnet Mapping:

  • Allows CIDR remapping for network conflicts
  • Validates private subnet CIDR formats
  • Automatically adjusts allocation pools for new CIDRs

Migration Process

1. Migration Creation

API Endpoint: POST /api/openstack-migrations/

Required Parameters:

  • src_resource: UUID of source marketplace resource (OpenStack tenant)
  • dst_offering: UUID of destination marketplace offering
  • dst_plan: UUID of plan for destination resource

Optional Parameters:

  • name: Custom name for destination resource
  • description: Description for destination resource
  • mappings: Configuration object for advanced mapping options

2. Resource Replication

The creation process involves several atomic steps:

  1. Destination Tenant Creation: Creates new tenant with generated credentials
  2. Network Topology Copy: Replicates networks, subnets, and routing
  3. Security Group Migration: Copies groups and rules with proper references
  4. Quota Application: Maps and applies resource limits
  5. Marketplace Integration: Creates destination resource record

3. Execution Pipeline

MigrationExecutor orchestrates the migration using Celery task chains:

1
2
3
4
5
6
7
def get_task_signature(migration):
    tasks = [
        StateTransitionTask("begin_creating"),
        get_tenant_create_tasks(dst_tenant, skip_external_network),
        get_create_ports_tasks(src_tenant, dst_tenant, networks)  # Optional
    ]
    return chain(*tasks)

Task Flow:

  1. State Transition: Mark migration as "creating"
  2. Tenant Provisioning: Execute OpenStack tenant creation workflow
  3. Port Replication: Copy ports if sync_instance_ports enabled

Network Migration Details

Network and Subnet Replication

The system performs network topology migration:

Networks:

  • Preserves MTU settings and descriptions
  • Maintains network names for consistency
  • Creates equivalent networks in destination tenant

Subnets:

  • Supports CIDR remapping via subnet mappings
  • Preserves DNS nameservers and host routes
  • Adjusts allocation pools for remapped CIDRs
  • Maintains gateway configuration

Example Network Selection:

1
2
3
4
5
6
7
8
{
  "mappings": {
    "networks": ["network-uuid-1", "network-uuid-2"],
    "subnets": [
      {"src_cidr": "192.168.1.0/24", "dst_cidr": "10.0.1.0/24"}
    ]
  }
}

Security Group Migration

Security Groups:

  • Copies all security groups with names and descriptions
  • Maintains group relationships for inter-group references
  • Creates equivalent groups in destination tenant

Security Rules:

  • Replicates all rule configurations (protocol, ports, direction)
  • Maps CIDR ranges according to subnet mappings
  • Resolves remote group references after all groups are created
  • Handles both ingress and egress rules

Router Configuration

Static Route Filtering:

  • Only migrates routes targeting destination subnet CIDRs
  • Prevents invalid route configurations in new environment
  • Preserves nexthop configurations where applicable

Port Synchronization

Advanced Port Migration

When sync_instance_ports is enabled, the system performs detailed port replication:

Port Types Handled:

  • Instance Ports: Ports connected to active instances (state=OK)
  • VIP Ports: Free ports in DOWN state for virtual IPs (device_owner="compute:nova")

Port Migration Process:

  1. Data Collection: Gather port configuration from source
  2. Security Group Mapping: Map security groups to destination equivalents
  3. Port Creation: Create port with preserved configuration
  4. Subnet Resolution: Update fixed IPs to use destination subnet IDs
  5. Backend Provisioning: Execute OpenStack port creation via backend

Port Data Structure:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
port_data = {
    "name": src_port.name,
    "description": src_port.description,
    "dst_tenant_id": dst_tenant.id,
    "dst_network_id": dst_network.id,
    "dst_subnet_id": dst_subnet.id,
    "port_security_enabled": src_port.port_security_enabled,
    "fixed_ips": src_port.fixed_ips,
    "mac_address": src_port.mac_address,
    "security_group_names": security_group_names
}

Quota and Limit Handling

Quota Preservation (serializers.py:318)

Standard Limits:

All marketplace limits are preserved:

  • CPU cores, RAM, storage quotas
  • Network and security group limits
  • Instance and volume quotas

Volume Type Quota Mapping:

  • Aggregates quotas for mapped volume types
  • Handles multiple source types mapping to single destination type
  • Preserves total storage allocation across type changes

Quota Application (serializers.py:376):

1
2
3
4
5
6
7
# Standard quotas from offering limits
quotas = map_limits_to_quotas(limits, dst_offering)

# Infrastructure quotas from source tenant
for quota_name in ("instances", "volumes", "snapshots",
                   "security_group_count", "security_group_rule_count"):
    quotas[quota_name] = src_tenant.get_quota_limit(quota_name)

Event Handling

Migration Lifecycle

Order Creation: When migration completes, marketplace orders are automatically created:

1
2
3
4
5
6
7
8
def handle_migration_post_save(sender, instance: Migration, created, **kwargs):
    if migration.state in (CoreStates.OK, CoreStates.ERRED):
        Order.objects.create(
            resource=migration.dst_resource,
            offering=migration.dst_resource.offering,
            state=OrderStates.DONE if state == CoreStates.OK else OrderStates.ERRED,
            # ... additional order fields
        )

Benefits:

  • Proper marketplace integration for billing and tracking
  • Audit trail for migration operations
  • Integration with approval workflows

API Reference

Migration Management

Create Migration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
POST /api/openstack-migrations/
Content-Type: application/json

{
  "src_resource": "source-tenant-uuid",
  "dst_offering": "destination-offering-uuid",
  "dst_plan": "destination-plan-uuid",
  "name": "Migrated Environment",
  "mappings": {
    "volume_types": [
      {"src_type_uuid": "uuid1", "dst_type_uuid": "uuid2"}
    ],
    "subnets": [
      {"src_cidr": "192.168.1.0/24", "dst_cidr": "10.0.1.0/24"}
    ],
    "networks": ["network-uuid-to-include"],
    "sync_instance_ports": true,
    "skip_connection_extnet": false
  }
}

List Migrations

1
GET /api/openstack-migrations/

Filters Available:

  • src_resource_uuid: Filter by source resource UUID
  • dst_resource_uuid: Filter by destination resource UUID

Migration Details Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "uuid": "migration-uuid",
  "created": "2023-01-01T00:00:00Z",
  "state": "OK",
  "src_offering_name": "Source OpenStack",
  "dst_offering_name": "Destination OpenStack",
  "src_resource_name": "Production Tenant",
  "dst_resource_name": "Migrated Production Tenant",
  "dst_resource_state": "OK",
  "mappings": {
    "volume_types": [...],
    "subnets": [...],
    "networks": [...],
    "sync_instance_ports": true
  }
}

Configuration Options

Network Selection

  • All Networks: Default behavior migrates all networks and subnets
  • Selective Networks: Use networks array to specify which networks to migrate
  • Subnet Remapping: Provide CIDR mappings to avoid IP conflicts

Port Synchronization Options

  • Instance Ports: Automatically included when sync_instance_ports=true
  • VIP Ports: Free ports for virtual IP configurations
  • Security Group Mapping: Preserves security associations

Volume Type Handling

  • One-to-One Mapping: Map each source type to destination equivalent
  • Many-to-One Mapping: Aggregate multiple source types to single destination
  • Quota Aggregation: Automatically sums quotas for merged types

Validation Rules

Pre-Migration Checks (serializers.py:156)

  1. Source Resource Validation:
  2. Must have limits configured

  3. Must be accessible to requesting user

  4. Destination Offering Validation:

  5. Must be available for ordering by user

  6. Plan must belong to selected offering

  7. Permission Validation:

  8. User must have tenant creation permissions in target project

  9. Order must not require consumer review (auto-approved)

  10. Mapping Validation:

  11. Volume types must exist in respective environments
  12. Cannot combine sync_instance_ports with subnet mappings
  13. Subnet CIDRs must be valid private network ranges

Error Handling

Migration Failures

  • Object Not Found: Gracefully handles missing dependencies
  • Backend Errors: Properly propagates OpenStack API failures
  • Validation Errors: Clear error messages for configuration issues
  • State Management: Failed migrations marked as ERRED with error details

Recovery Mechanisms

  • Partial Success: Network migration continues even if some components fail
  • Security Group Recovery: Handles missing security groups during port creation
  • Route Validation: Filters invalid routes to prevent configuration errors

Integration with Marketplace

Resource Lifecycle

  1. Resource Creation: Destination resource created before migration starts
  2. Order Generation: Marketplace order created on migration completion
  3. Billing Integration: Proper cost tracking for migrated resources
  4. State Synchronization: Resource state reflects migration progress

Permissions Integration

  • Uses marketplace permission system for access control
  • Integrates with project-level permissions
  • Respects offering availability rules

Performance Considerations

Transaction Safety

  • Uses @transaction.atomic for data consistency
  • Commits migration execution after successful creation
  • Prevents partial state corruption during failures

Async Execution

  • Migration execution happens asynchronously via Celery
  • Non-blocking API responses with immediate migration record
  • Background processing for time-intensive operations

Resource Optimization

  • Selective network migration reduces unnecessary copying
  • Efficient quota aggregation for volume type mappings
  • Optimized ancestor traversal in quota calculations

Use Cases

1. Service Provider Migration

Migrate tenants between different OpenStack clouds:

1
2
3
4
5
6
7
8
9
{
  "src_resource": "old-provider-tenant",
  "dst_offering": "new-provider-offering",
  "mappings": {
    "volume_types": [
      {"src_type_uuid": "ssd-old", "dst_type_uuid": "ssd-new"}
    ]
  }
}

2. Development Environment Replication

Copy production tenant to development environment:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "src_resource": "prod-tenant",
  "dst_offering": "dev-offering",
  "name": "Development Environment",
  "mappings": {
    "subnets": [
      {"src_cidr": "10.0.1.0/24", "dst_cidr": "192.168.1.0/24"}
    ]
  }
}

3. Disaster Recovery Setup

Replicate critical infrastructure with port synchronization:

1
2
3
4
5
6
7
8
{
  "src_resource": "primary-tenant",
  "dst_offering": "dr-offering",
  "mappings": {
    "sync_instance_ports": true,
    "networks": ["critical-network-uuid"]
  }
}

Limitations and Considerations

Current Limitations

  • Instance Migration: Does not migrate actual VM instances (infrastructure only)
  • Volume Data: Does not copy volume data (structure only)
  • Floating IPs: External network connections not fully replicated
  • Custom Metadata: Some OpenStack metadata may not be preserved

Security Considerations

  • Credential Generation: New tenant gets fresh random credentials
  • Network Isolation: Maintains network isolation in destination environment
  • Permission Boundaries: Respects Waldur's permission system throughout

Planning Considerations

  • IP Address Conflicts: Plan subnet mappings to avoid IP conflicts
  • Volume Type Availability: Ensure destination volume types exist
  • Quota Limits: Verify destination environment can accommodate quotas
  • Network Dependencies: Consider external network connectivity requirements

Testing

The plugin includes comprehensive test coverage:

Migration Tests (tests/test_migration.py)

  • Basic Migration: Validates complete tenant migration workflow
  • Network Selection: Tests selective network migration
  • Volume Type Mapping: Verifies quota aggregation across type mappings
  • Security Group Replication: Ensures proper rule and reference handling
  • Error Handling: Tests graceful failure scenarios

Port Task Tests

  • Port Creation: Validates successful port replication
  • Error Recovery: Tests handling of missing dependencies
  • Security Group Association: Verifies proper security group mapping

Configuration

App Registration (apps.py:5)

1
2
3
4
5
6
class OpenStackReplicationConfig(AppConfig):
    name = "waldur_openstack_replication"

    def ready(self):
        # Register migration state change handler
        post_save.connect(handle_migration_post_save, sender=Migration)

URL Configuration (urls.py:4)

1
2
3
def register_in(router):
    router.register(r"openstack-migrations", MigrationViewSet,
                   basename="openstack-migrations")

Extension Integration (extension.py:4)

1
2
3
4
class OpenStackReplicationExtension(WaldurExtension):
    @staticmethod
    def django_app():
        return "waldur_openstack_replication"

Best Practices

Migration Planning

  1. Pre-Migration Analysis: Review source tenant configuration
  2. Quota Verification: Ensure destination has sufficient quotas
  3. Network Planning: Design subnet mappings to avoid conflicts
  4. Volume Type Mapping: Map storage types based on performance requirements

Execution Guidelines

  1. Test Migrations: Perform test migrations before production
  2. Selective Migration: Use network selection for large tenants
  3. Monitor Progress: Track migration state through API
  4. Post-Migration Validation: Verify all components migrated correctly

Troubleshooting

  1. Check Logs: Review migration error messages and tracebacks
  2. Validate Permissions: Ensure proper access to source and destination
  3. Verify Dependencies: Confirm all required resources exist
  4. Resource Cleanup: Clean up failed migrations manually if needed

OpenStack Plugin

Introduction

The OpenStack plugin for Waldur provides comprehensive integration with OpenStack cloud infrastructure, enabling organizations to manage OpenStack resources through Waldur's unified platform. This plugin acts as a bridge between Waldur's resource management capabilities and OpenStack's Infrastructure-as-a-Service (IaaS) offerings.

Core Functionality

The plugin enables:

  • Multi-tenant Resource Management: Create and manage OpenStack projects (tenants) with isolated resources
  • Compute Resource Provisioning: Deploy and manage virtual machines with full lifecycle control
  • Storage Management: Provision block storage volumes, create snapshots, and manage backups
  • Network Configuration: Set up virtual networks, subnets, routers, and security policies
  • Quota Management: Synchronize and enforce resource quotas between Waldur and OpenStack
  • Cross-tenant Resource Sharing: Share networks between tenants using RBAC policies
  • Automated Resource Discovery: Import existing OpenStack resources into Waldur
  • Console Access: Provide direct console access to virtual machines

Supported Operations by OpenStack Service

Keystone (Identity Service)

Operation Description API Endpoint
Tenant Creation Create new OpenStack projects/tenants POST /api/openstack-tenants/
Tenant Deletion Remove OpenStack projects DELETE /api/openstack-tenants/{uuid}/
Authentication Manage tenant credentials Handled internally
Quota Retrieval Fetch tenant quotas GET /api/openstack-tenants/{uuid}/quotas/
Quota Update Modify tenant quotas POST /api/openstack-tenants/{uuid}/set_quotas/

Nova (Compute Service)

Operation Description API Endpoint
Instances
Create Instance Launch new virtual machines POST /api/openstack-instances/
Delete Instance Terminate virtual machines DELETE /api/openstack-instances/{uuid}/
Start Instance Power on virtual machines POST /api/openstack-instances/{uuid}/start/
Stop Instance Power off virtual machines POST /api/openstack-instances/{uuid}/stop/
Restart Instance Reboot virtual machines POST /api/openstack-instances/{uuid}/restart/
Resize Instance Change instance flavor POST /api/openstack-instances/{uuid}/change_flavor/
Console Access Get VNC console URL POST /api/openstack-instances/{uuid}/console/
Attach Volume Connect storage to instance POST /api/openstack-instances/{uuid}/attach_volume/
Detach Volume Disconnect storage from instance POST /api/openstack-instances/{uuid}/detach_volume/
Assign Floating IP Attach public IP POST /api/openstack-instances/{uuid}/assign_floating_ip/
Flavors
List Flavors Get available VM sizes GET /api/openstack-flavors/
Import Flavors Sync flavors from backend POST /api/openstack-tenants/{uuid}/pull_flavors/
Images
List Images Get available OS images GET /api/openstack-images/
Import Images Sync images from backend POST /api/openstack-tenants/{uuid}/pull_images/
Server Groups
Create Server Group Set up affinity policies POST /api/openstack-server-groups/
Delete Server Group Remove affinity policies DELETE /api/openstack-server-groups/{uuid}/
Availability Zones
List AZs Get compute availability zones GET /api/openstack-instance-availability-zones/

Cinder (Block Storage Service)

Operation Description API Endpoint
Volumes
Create Volume Provision block storage POST /api/openstack-volumes/
Delete Volume Remove block storage DELETE /api/openstack-volumes/{uuid}/
Extend Volume Increase volume size POST /api/openstack-volumes/{uuid}/extend/
Attach to Instance Connect volume to VM POST /api/openstack-volumes/{uuid}/attach/
Detach from Instance Disconnect volume from VM POST /api/openstack-volumes/{uuid}/detach/
Create from Snapshot Restore volume from snapshot POST /api/openstack-volumes/{uuid}/create_from_snapshot/
Snapshots
Create Snapshot Create volume snapshot POST /api/openstack-snapshots/
Delete Snapshot Remove snapshot DELETE /api/openstack-snapshots/{uuid}/
Restore Snapshot Create volume from snapshot POST /api/openstack-snapshots/{uuid}/restore/
Volume Types
List Volume Types Get storage types (SSD/HDD) GET /api/openstack-volume-types/
Import Volume Types Sync types from backend POST /api/openstack-tenants/{uuid}/pull_volume_types/
Backups
Create Backup Create volume backup POST /api/openstack-backups/
Delete Backup Remove backup DELETE /api/openstack-backups/{uuid}/
Restore Backup Restore volume from backup POST /api/openstack-backups/{uuid}/restore/

Neutron (Networking Service)

Operation Description API Endpoint
Networks
Create Network Set up virtual network POST /api/openstack-networks/
Delete Network Remove virtual network DELETE /api/openstack-networks/{uuid}/
Update Network Modify network properties PATCH /api/openstack-networks/{uuid}/
Subnets
Create Subnet Define IP address pool POST /api/openstack-subnets/
Delete Subnet Remove subnet DELETE /api/openstack-subnets/{uuid}/
Update Subnet Modify subnet configuration PATCH /api/openstack-subnets/{uuid}/
Routers
Create Router Set up network router POST /api/openstack-routers/
Delete Router Remove router DELETE /api/openstack-routers/{uuid}/
Add Interface Connect subnet to router POST /api/openstack-routers/{uuid}/add_interface/
Remove Interface Disconnect subnet from router POST /api/openstack-routers/{uuid}/remove_interface/
Set Gateway Configure external gateway POST /api/openstack-routers/{uuid}/set_gateway/
Ports
Create Port Create network interface POST /api/openstack-ports/
Delete Port Remove network interface DELETE /api/openstack-ports/{uuid}/
Update Port Modify port configuration PATCH /api/openstack-ports/{uuid}/
Floating IPs
Allocate Floating IP Reserve public IP POST /api/openstack-floating-ips/
Release Floating IP Release public IP DELETE /api/openstack-floating-ips/{uuid}/
Associate Floating IP Attach to instance POST /api/openstack-floating-ips/{uuid}/assign/
Disassociate Floating IP Detach from instance POST /api/openstack-floating-ips/{uuid}/unassign/
Security Groups
Create Security Group Set up firewall rules POST /api/openstack-sgp/
Delete Security Group Remove firewall rules DELETE /api/openstack-sgp/{uuid}/
Add Rule Create firewall rule POST /api/openstack-sgp/{uuid}/rules/
Remove Rule Delete firewall rule DELETE /api/openstack-sgp/{uuid}/rules/{rule_id}/
RBAC Policies
Create RBAC Policy Share network between tenants POST /api/openstack-network-rbac-policies/
List RBAC Policies View sharing policies GET /api/openstack-network-rbac-policies/

Glance (Image Service)

Operation Description API Endpoint
List Images Get available images GET /api/openstack-images/
Import Images Sync images from Glance Handled via tenant sync
Image Metadata Get image properties Included in image list

Network Requirements

Required Network Connectivity

The following table outlines the network ports and protocols required for Waldur to communicate with OpenStack services:

Service Port Protocol Direction Description Required
Keystone (Identity) 5000 HTTPS/HTTP Outbound Public API endpoint for authentication ✅ Yes
Keystone (Admin) 35357 HTTPS/HTTP Outbound Admin API endpoint (deprecated in newer versions) ⚠️ Version dependent
Nova (Compute) 8774 HTTPS/HTTP Outbound Compute API for instance management ✅ Yes
Cinder (Block Storage) 8776 HTTPS/HTTP Outbound Volume API for storage management ✅ Yes
Neutron (Networking) 9696 HTTPS/HTTP Outbound Network API for networking operations ✅ Yes
Glance (Images) 9292 HTTPS/HTTP Outbound Image API for image management ✅ Yes
Nova VNC Console 6080 HTTPS/HTTP Outbound VNC console proxy for instance access ⚠️ Optional*
Horizon Dashboard 80/443 HTTPS/HTTP Outbound Generate links to OpenStack web UI for users ⚠️ Optional**

* Required only if console access feature is enabled * Only used to generate dashboard URLs for user convenience; not required for API operations*

Network Configuration Notes

  1. SSL/TLS Requirements:
  2. HTTPS is strongly recommended for all API communications
  3. Self-signed certificates are supported but require configuration

  4. Certificate validation can be disabled for testing (not recommended for production)

  5. Firewall Considerations:

  6. All connections are initiated from Waldur to OpenStack (outbound only)
  7. No inbound connections to Waldur are required from OpenStack

  8. Stateful firewall rules should allow return traffic

  9. API Endpoint Discovery:

  10. Waldur uses Keystone service catalog for endpoint discovery
  11. Only the Keystone endpoint needs to be explicitly configured

  12. Other service endpoints are automatically discovered from the service catalog

  13. Network Latency:

  14. API timeout: 60 seconds (configurable)
  15. Recommended latency: < 100ms
  16. Long-running operations use asynchronous task queues

Configuration

Marketplace-Based Configuration

OpenStack integration in Waldur is configured through Marketplace offerings. The plugin provides three offering types for different resource levels:

Offering Type Purpose Resource Scope
OpenStack.Tenant Provision and manage OpenStack projects/tenants Provider-level
OpenStack.Instance Provision virtual machines within a tenant Tenant-level
OpenStack.Volume Provision block storage volumes within a tenant Tenant-level

Configuring an OpenStack Provider

To set up an OpenStack provider, create a Marketplace offering of type OpenStack.Tenant with the following configuration:

Required Connection Settings

Parameter Location Description Example
backend_url secret_options Keystone API endpoint URL https://keystone.example.com:5000/v3
username secret_options Admin account username admin
password secret_options Admin account password secure_password
tenant_name secret_options Admin tenant/project name admin
domain secret_options Keystone domain (v3 only) default

Network Configuration

Parameter Location Description Required
external_network_id secret_options UUID of external network for floating IPs Yes
default_internal_network_mtu plugin_options MTU for tenant internal networks (68-9000) No
ipv4_external_ip_mapping secret_options NAT mapping for floating IPs No

Optional Settings

Parameter Location Description Default
access_url options Horizon dashboard URL for user links Generated from backend_url
verify_ssl options Verify SSL certificates true
availability_zone options Default availability zone nova
storage_mode plugin_options Storage quota mode (fixed or dynamic) fixed

Storage Modes

The plugin supports two storage quota modes:

Mode Description Use Case
fixed Single storage quota shared by all volume types Simple environments with uniform storage
dynamic Separate quotas per volume type (SSD, HDD, etc.) Environments with tiered storage offerings

When using dynamic storage mode, volume types are automatically synchronized from OpenStack and created as offering components.

Resource Components

OpenStack tenant offerings include the following billable components:

Component Type Description Unit Default Limit
cores CPU cores Count 20
ram Memory MB 51200
storage Block storage (fixed mode) MB 1048576
volume_type_* Per-type storage (dynamic mode) MB Varies

Automated Private Offerings

When AUTOMATICALLY_CREATE_PRIVATE_OFFERING is enabled in settings, the plugin automatically creates private offerings for instances and volumes when a tenant is provisioned. This allows tenant users to order resources through the Marketplace interface.

Quota Mapping

OpenStack quotas are automatically synchronized with Waldur quotas:

OpenStack Quota Waldur Quota Default Limit
cores vcpu 20
ram ram 51200 MB
instances instances 30
volumes volumes 50
gigabytes storage 1024 GB
snapshots snapshots 50
security_groups security_group_count 100
security_group_rules security_group_rule_count 100
floatingip floating_ip_count 50
network network_count 10
subnet subnet_count 10
port port_count Unlimited

Scheduled Tasks

The plugin runs the following automated tasks:

Task Schedule Purpose
Pull Quotas Every 12 hours Synchronize quotas with OpenStack
Pull Resources Every 1 hour Update resource states
Pull Sub-resources Every 2 hours Sync networks, subnets, ports
Pull Properties Every 24 hours Update flavors, images, volume types
Cleanup Stuck Resources Every 1 hour Mark stuck resources as erred
Delete Expired Backups Every 10 minutes Remove backups past retention
Delete Expired Snapshots Every 10 minutes Remove snapshots past retention

Security Considerations

  1. Credential Management:
  2. Service account credentials are stored in database secret_options field
  3. Per-tenant credentials are auto-generated using random passwords
  4. Tenant credentials visibility can be controlled via TENANT_CREDENTIALS_VISIBLE setting

  5. SSH keys are automatically distributed to tenants based on user permissions

  6. Network Security:

  7. Security groups provide instance-level firewalling
  8. Default deny-all policy for new security groups
  9. RBAC policies control cross-tenant network resource sharing

  10. External IP mapping supports NAT scenarios

  11. Audit Logging:

  12. All operations are logged with user attribution
  13. Resource state changes tracked in event log
  14. Failed operations logged with error details
  15. Quota changes trigger audit events

Troubleshooting

Common Issues

  1. Connection Timeouts:
  2. Verify network connectivity to Keystone endpoint
  3. Check firewall rules for required ports

  4. Validate SSL certificates if using HTTPS

  5. Authentication Failures:

  6. Verify service account credentials
  7. Check domain configuration for Keystone v3

  8. Ensure service account has admin privileges

  9. Quota Synchronization Issues:

  10. Check OpenStack policy files for quota permissions
  11. Verify nova, cinder, and neutron quota drivers

  12. Review background task logs

  13. Resource State Mismatches:

  14. Trigger manual pull operation
  15. Check OpenStack service status
  16. Review executor task logs

Marketplace Integration

The OpenStack plugin integrates with Waldur Marketplace through the marketplace_openstack module, providing:

  • Simplified instance and volume ordering
  • Component-based pricing (CPU, RAM, Storage)
  • Automated provisioning workflows
  • Resource metadata management
  • Usage tracking for billing

API Reference

For detailed API documentation, refer to the Waldur API schema at /api/schema/ with the OpenStack plugin enabled.

Waldur plugins

Plugin as extension

Waldur extensions are developed as auto-configurable plugins. One plugin can contain several extensions which is a pure Django application by its own. In order to be recognized and automatically connected to Waldur some additional configuration required.

Extensions' URLs will be registered automatically only if settings.WALDUR_CORE['EXTENSIONS_AUTOREGISTER'] is True, which is default.

Create a class inherited from waldur_core.core.WaldurExtension. Implement methods which reflect your app functionality. At least django_app() should be implemented.

Add an entry point of name waldur_extensions to pyproject.toml:

1
2
[project.entry-points.waldur_extensions]
waldur_demo = "waldur_demo.extension:DemoExtension"

Plugin documentation

  1. Keep plugin's documentation within plugin's code repository.

  2. The documentation page should start with plugin's title and description.

  3. Keep plugin's documentation page structure similar to the Waldur's main documentation page:

    Guide - should contain at least installation steps. API - should include description of API extension, if any.

Ticket-Based Offerings

Ticket-based offerings integrate Waldur marketplace with external ticketing systems (JIRA, SMAX, Zammad) to manage service provisioning through support tickets.

Overview

When offerings are configured with type = "Marketplace.Support", orders are processed through external ticketing systems rather than direct API provisioning. This enables:

  • Manual service provisioning workflows
  • Integration with existing ITSM processes
  • Human approval and intervention
  • Complex provisioning that requires multiple steps

Architecture

graph LR
    Order[Marketplace Order] --> Issue[Support Issue]
    Issue --> Backend[Ticketing Backend]
    Backend --> Status[Status Change]
    Status --> Callback[Resource Callback]
    Callback --> Resource[Resource State]

Order Processing Flow

1. Order Creation

When a customer creates an order for a ticket-based offering:

  • A support issue is created in the configured backend (JIRA/SMAX/Zammad)
  • The order is linked to the issue via issue.resource
  • The issue contains order details in its description

2. Status Synchronization

The system monitors issue status changes through:

  • Backend synchronization (sync_issues())
  • Webhooks (JIRA, SMAX, Zammad - if configured)
  • Periodic polling

3. Callback Triggering

When an issue status changes, the system determines the appropriate callback based on:

  • Order Type (CREATE, UPDATE, TERMINATE)
  • Resolution Status (resolved, canceled)

The callback mapping is defined in marketplace_support/handlers.py:

1
2
3
4
5
6
7
8
RESOURCE_CALLBACKS = {
    (ItemTypes.CREATE, True): callbacks.resource_creation_succeeded,
    (ItemTypes.CREATE, False): callbacks.resource_creation_canceled,
    (ItemTypes.UPDATE, True): callbacks.resource_update_succeeded,
    (ItemTypes.UPDATE, False): callbacks.resource_update_failed,
    (ItemTypes.TERMINATE, True): callbacks.resource_deletion_succeeded,
    (ItemTypes.TERMINATE, False): callbacks.resource_deletion_failed,
}

Issue Resolution Detection

The system determines if an issue is resolved or canceled through the IssueStatus model:

IssueStatus Configuration

Each status name from the ticketing system maps to one of two types:

  • IssueStatus.Types.RESOLVED (0) - Successfully completed
  • IssueStatus.Types.CANCELED (1) - Failed or canceled

Model Structure:

1
2
3
4
class IssueStatus:
    uuid: UUID          # Unique identifier for API access
    name: str           # Exact status name from backend system
    type: int           # 0=RESOLVED, 1=CANCELED

Example Configuration:

1
2
3
4
# In the database/admin:
IssueStatus.objects.create(name="Done", type=IssueStatus.Types.RESOLVED)
IssueStatus.objects.create(name="Rejected", type=IssueStatus.Types.CANCELED)
IssueStatus.objects.create(name="Canceled", type=IssueStatus.Types.CANCELED)

Access Control:

  • Staff users: Full CRUD access via API and admin interface
  • Support users: Read-only access (can view existing statuses)
  • Regular users: No access

Resolution Logic

  1. When an issue's status changes (e.g., from backend sync)
  2. The issue.resolved property is evaluated:
  3. Looks up the status name in IssueStatus table
  4. Returns True if type is RESOLVED
  5. Returns False if type is CANCELED

  6. Returns None for other statuses

  7. Based on (order.type, issue.resolved) combination, the appropriate callback is triggered

Resource Deletion Failed Scenario

The resource_deletion_failed callback is triggered when:

  1. Issue Status Changes: The support ticket's status is updated
  2. Order Type is TERMINATE: The order represents a resource deletion request
  3. Status Maps to CANCELED: The new status is configured as IssueStatus.Types.CANCELED
  4. Callback Execution: callbacks.resource_deletion_failed(order.resource) is called

This typically happens when:

  • Support staff reject a deletion request
  • Technical issues prevent resource removal
  • Business rules block the deletion
  • The request is canceled before completion

Configuration

Backend Setup

Configure the ticketing backend in settings:

1
2
3
4
5
WALDUR_SUPPORT = {
    'BACKEND': 'waldur_mastermind.support.backend.smax.SmaxBackend',
    # or 'waldur_mastermind.support.backend.atlassian.ServiceDeskBackend'
    # or 'waldur_mastermind.support.backend.zammad.ZammadBackend'
}

Status Mapping

IssueStatus objects can be configured through the API or admin interface to map backend statuses correctly.

API Management (Staff Only)

Staff users can manage IssueStatus configurations through the REST API:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# List all status mappings
GET /api/support-issue-statuses/

# Create a new status mapping
POST /api/support-issue-statuses/
Content-Type: application/json

{
  "name": "Done",
  "type": 0  // 0 = RESOLVED, 1 = CANCELED
}

# Update existing status mapping
PATCH /api/support-issue-statuses/{uuid}/
Content-Type: application/json

{
  "name": "Completed",
  "type": 0
}

# Delete status mapping
DELETE /api/support-issue-statuses/{uuid}/

Response Format:

1
2
3
4
5
6
7
{
  "url": "https://waldur.example.com/api/support-issue-statuses/abc123/",
  "uuid": "abc123-def456-...",
  "name": "Done",
  "type": 0,
  "type_display": "Resolved"
}

Programmatic Setup

For automated deployment, use data migrations or management commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Admin interface or data migration
resolved_statuses = ["Done", "Resolved", "Completed"]
canceled_statuses = ["Rejected", "Canceled", "Failed", "Won't Do"]

for status in resolved_statuses:
    IssueStatus.objects.get_or_create(
        name=status,
        defaults={'type': IssueStatus.Types.RESOLVED}
    )

for status in canceled_statuses:
    IssueStatus.objects.get_or_create(
        name=status,
        defaults={'type': IssueStatus.Types.CANCELED}
    )

Best Practices

  1. Status Configuration: Ensure all possible backend statuses are mapped in IssueStatus
  2. Use the /api/support-issue-statuses/ API for programmatic management
  3. Staff users should regularly review and update status mappings

  4. Document your backend's status workflow and map all statuses accordingly

  5. Monitoring: Regularly sync issues to detect status changes

  6. Error Handling: Implement proper error handling in callbacks
  7. Logging: Monitor handler execution through logs for debugging
  8. Testing: Test status transitions with different order types
  9. API Management: Use the REST API for consistent status configuration across environments

Troubleshooting

Callbacks Not Firing

  • Check if IssueStatus entries exist for the backend's status values
  • Verify the offering type is set to "Marketplace.Support"
  • Ensure issue synchronization is running
  • Check logs for handler execution

Wrong Callback Triggered

  • Review IssueStatus type configuration
  • Verify the order type (CREATE/UPDATE/TERMINATE)
  • Check the issue resolution logic in logs

Missing Status Mappings

If you see critical log messages about missing statuses:

1
"There is no information about statuses of an issue. Please, add resolved and canceled statuses in admin."

Resolution Options:

  1. API Management (Recommended): Use the REST API to add missing statuses:
1
2
3
4
5
6
7
POST /api/support-issue-statuses/
Content-Type: application/json

{
  "name": "YourBackendStatus",
  "type": 0  // or 1 for CANCELED
}

  1. Admin Interface: Add the required IssueStatus entries through Django admin

  2. Identify Missing Statuses: Check your backend system for all possible status values and ensure each has a corresponding IssueStatus entry

Common Missing Statuses by Backend:

  • JIRA: "To Do", "In Progress", "Done", "Cancelled"
  • SMAX: "Open", "In Progress", "Resolved", "Rejected"
  • Zammad: "new", "open", "pending reminder", "pending close", "closed"

Use GET /api/support-issue-statuses/ to view currently configured statuses and compare against your backend's status list.

Valimo authentication plugin

Valimo endpoint allows to get Waldur authentication token using mobile PKI from Valimo. Please note, that only authentication is supported - no auto-registration is currently available.

  • To initiate a login process, please issue POST request against /api/auth-valimo/ endpoint providing phone number as an input.

  • On that request Waldur will create a result object (AuthResult) and request authentication from the Valimo PKI service. The result object contains all the metadata about the request, including field message - text that is sent to the user via SMS. This text is typically shown to the user for validation purposes.

  • The client is expected to poll for the authentication process by issuing POST requests against /api/auth-valimo/result/ with UUID in the payload of a request. Please see details in the API documentation.

  • After a successful login, endpoint /api/auth-valimo/result/ will contain authentication token.

OpenStack plugin

OpenStack is a popular open-source toolkit for building private clouds.

OpenStack backups

Backups allow storing backups of instances outside of an OpenStack deployment and restoring it on other deployment.

On backup creation Waldur creates cinder backups for each volume of the instance, stores instance metadata and exports and saves metadata records of cinder backups.

On backup restoration Waldur creates cinder backups in a new tenant, based on saved metadata records. After that it creates new volumes and restores cinder backups into them. Finally, Waldur creates new instance based on restored volumes and backup metadata.

REST API

To create new backup, issue POST request with instance, backup name and description to /api/openstack-backups/ endpoint. backup has fields state and runtime_state that indicate backup creation progress.

It is possible to update backup name and description with POST request against /api/openstack-backups/<uuid>/ endpoint.

To restore backup - issue POST request with backup, new tenant and new instance flavor against /api/openstack-backups/<uuid>/restore/ endpoint. Make sure that flavor is big enough for instance. You can check backup metadata to get stored instance minimum ram, cores and storage. On successful start of the restoration, endpoint will return URL of an instance that should will be created from backup, field state of this instance indicates restoration process progress.

For more detailed endpoints description - please check endpoints documentation.

Resources import

Waldur is able to import existing OpenStack tenants, instances and volumes. This allows you take resources you've created and bring it under Waldur management.

To get list of available volumes to import send GET request to marketplace-offerings//importable_resources/ endpoint.

To import volume send POST-request with the following parameters to marketplace-offerings//import_resource endpoint:

  • project a UUID of project used for import;
  • backend_id a backend id of the resource to be imported;
  • plan an optional UUID of plan used for import.

OpenStack instances

When a VM instance is created through Waldur, it is created using Cinder service with 2 volumes:

  • root volume containing OS root image, bootable;
  • data volume an empty volume for data.

VM resize (flavor). To change memory or CPU number, a flavor should be changed. Please note, that the disk size is not affected. Change can happen only for a stopped VM.

VM resize (disk). Increasing a disk size means extension of the data volume attached to the instance. The process includes detaching of a data volume, extending it and re-attaching to a VM. Disk can be increased only for a stopped VM.

Ended: Openstack

Ended: Plugins

Ended: Developer guide

Integrations ↵

Integrations

Waldur connects with a wide range of resource providers, identity services, and management tools to create a comprehensive orchestration platform. These integrations are continually expanded based on user requirements and can be customized for specific deployments.

Resource Provider Integrations

Compute and Cloud Services

  • OpenStack - Complete integration with OpenStack's core services (Keystone, Nova, Cinder, Glance, and Neutron) enabling management of projects, networks, subnets, floating IPs, instances, and more.

  • MS Azure - Support for creating, importing, and managing Virtual Machines on Microsoft Azure public cloud.

  • VMware - Integration with VMware virtualization platform for managing virtual infrastructure resources.

HPC and Scientific Computing

  • SLURM and MOAB - Integration with popular HPC workload managers and job scheduling systems through Waldur Site Agent, providing web-based self-service for accounts and allocation management. Site Agent supports both SLURM and MOAB workload managers, allowing efficient management of HPC resources.

  • Open OnDemand - Web-based portal for accessing HPC resources, integrated with Waldur through KeyCloak and SLURM plugins for unified account and permission management, enabling researchers to access computational resources through a user-friendly interface.

  • LEXIS Integration - Support for LEXIS (Large-scale EXecution for Industry & Society) platform integration, allowing Waldur resources to be linked with LEXIS workflows for enhanced HPC and data management capabilities.

Identity Provider Integrations

Waldur supports multiple authentication methods to meet diverse organizational needs:

  • EduGAIN - Full integration as an EduGAIN Service Provider with support for CoCo extensions, enabling secure federated academic identity management.

  • LDAP/Active Directory - Connect to existing directory services such as FreeIPA, OpenLDAP, or Active Directory with flexible schema configuration.

  • MyAccessID - Integration with GEANT's MyAccessID service, including support for Puhuri-specific APIs for enhanced functionality.

  • Keycloak - Comprehensive support for Keycloak identity servers with advanced features:

  • Group synchronization capability, maintaining alignment between Keycloak groups and Waldur's internal structure
  • Custom Keycloak mappers for Waldur OfferingUser usernames and group access

  • MinIO integration for policy-based access control

  • SAML2 - Support for generic SAML-based identity federations with automated account creation and updates based on SAML attributes.

  • Waldur DB - Built-in user management with customizable profile fields to adapt to specific deployment requirements.

  • GLAuth - Lightweight LDAP server integration for simple user directory management with automated config refreshing.

Service Desk Integrations

Waldur integrates with several service desk solutions to enable end-to-end support ticket management:

  • Atlassian ServiceDesk - Integration with both on-premises and cloud versions
  • Zammad - Open-source help desk/customer support system integration
  • Microfocus SMAX - Enterprise service management integration

These integrations allow users to create support requests directly from Waldur, view ticket history and status, and interact with support personnel without leaving the Waldur interface.

AI and Automation Integrations

  • Claude Desktop Integration - Waldur MCP (Model Context Protocol) server enables Claude AI assistant to query Waldur instances for reporting and deep analysis of resources and usage data, enhancing decision-making capabilities.

Additional Integrations

  • Monitoring & Analytics - Support for Prometheus and Grafana for metrics collection and visualization.
  • Backup Solutions - Database backup capabilities with support for S3-compatible storage services.

New integrations are continuously being developed based on user requirements. For custom integration needs, please contact the Waldur development team.

Systemd setup for glauth and config refresher

Prerequisites:

  1. Ensure wget is installed to a target machine as refreshing script uses it;
  2. Install glauth binary to /usr/bin/glauth upon staring glauth service, e.g. glauth v2.3.0.

Refresher service

Copy the files from this repository to a corresponding paths on the target host:

1
2
3
4
5
mkdir /etc/glauth
cp systemd-conf/refresher/preconfig.cfg.template /etc/glauth/preconfig.cfg.template
cp systemd-conf/refresher/refresher.env /etc/glauth/refresher.env
cp systemd-conf/refresher/refresh-glauth-config.sh /usr/sbin/refresh-glauth-config.sh
cp systemd-conf/refresher/refresh-glauth-config.service /etc/systemd/system/refresh-glauth-config.service

Update .env file for the refresher service, i.e. /etc/glauth/refresher.env:

1
2
3
4
5
6
7
8
WALDUR_URL=https://waldur.example.com/api/
WALDUR_TOKEN=891a3dee2b905d08ed672d407308020d241c4f31
WALDUR_OFFERING_UUID=94dd1cec1f3940ef017e
WALDUR_API_VERIFY_TLS=false
LDAP_ADMIN_UIDNUMBER=4000
LDAP_ADMIN_PGROUP=4000
LDAP_ADMIN_USERNAME=admin
LDAP_ADMIN_PASSWORD=Adm1n!

Update systemd daemon configs and start and enabled the service:

1
2
3
systemctl daemon-reload
systemctl start refresh-glauth-config
systemctl enable refresh-glauth-config

After some time, you should be able to check the prepared config file in /etc/glauth/config.cfg

Glauth service

Ensure glauth binary is installed in /usr/bin/glauth and perform the same steps for the glauth service:

1
2
3
4
cp systemd-conf/glauth/glauth.service /etc/systemd/system/glauth.service
systemctl daemon-reload
systemctl start glauth
systemctl enable glauth

Integrating LEXIS with Waldur

To create a LEXIS link integration with a Waldur resource the API request shown below can be sent (http refers to HTTPie client).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
http POST https://waldur.example.com/api/lexis-links/ Authorization:"Token e63ffc6408afc4ft874fc5fb4dbcebf1277ca723" resource=https://waldur.example.com/api/marketplace-resources/a5dad412c0d94aeb8cffad3d0ca325ea/
HTTP/1.1 200 OK
Accept: application/json, text/plain, */*
Accept-Language: en
HTTP/1.1 201 Created
Date: Mon, 23 Oct 2023 07:31:08 GMT
Content-Type: application/json
Vary: Accept, Accept-Language, Cookie, Origin
Allow: GET, POST, HEAD, OPTIONS
X-Frame-Options: DENY
Content-Length: 2
Content-Language: en
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: x-result-count, Link

Alternatively this can be done through UI of Waldur as shown below.

Note: To be able to create a LEXIS link for a resource using Waldur UI:

  1. the offering related to the resource has to have plugin_options set;
  2. the feature Enabled LEXIS link integrations for offerings. should be enabled in Waldur site settings.

Namely:

  • heappe_url
  • heappe_username
  • heappe_cluster_id
  • heappe_local_base_path

You can set these settings via UI:

Offering edit page LEXIS settings edit

After offering setup, you can create a LEXIS link for an existing resource:

LEXIS link create LEXIS link creation submit

To view all LEXIS links the API request shown below can be sent.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
http GET https://waldur.example.com/api/lexis-links/ Authorization:"Token e63ffc6408afc4ft874fc5fb4dbcebf1277ca723"
Accept: application/json, text/plain, */*
Accept-Language: en
HTTP/1.1 200 OK
Date: Mon, 23 Oct 2023 08:09:41 GMT
Content-Type: application/json
X-Result-Count: 4
Link: <https://waldur.example.com/api/lexis-links/?page_size=10>; rel="first", <https://waldur.example.com/api/lexis-links/?page_size=10>; rel="last"
Vary: Accept, Accept-Language, Cookie, Origin
Allow: GET, POST, HEAD, OPTIONS
X-Frame-Options: DENY
Content-Length: 2965
Content-Language: en
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: x-result-count, Link

Response example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
[
  {
    "url":"https://waldur.example.com/api/lexis-links/6aaa620c60e14f21bd0817360db005ed/",
    "uuid":"6aaa620c60e14f21bd0817360db005ed",
    "created":"2023-10-23T08:57:44.031155Z",
    "modified":"2023-10-23T08:57:44.031155Z",
    "robot_account":"https://waldur.example.com/api/marketplace-robot-accounts/8ae5711c788f4700aab9480deed9e2bd/",
    "robot_account_username":"",
    "robot_account_type":"hl006",
    "state":"pending",
    "resource_uuid":"a5dad412c0d94aeb8cffad3d0ca325ea",
    "resource_name":"brandturn-keybandwidth",
    "resource_backend_id":"dca3f539-3215-476d-b68b-36d8844502f0",
    "resource_end_date":null,
    "project_uuid":"f5b14e76985349d8b5f91325702fde1b",
    "project_name":"Automated coherent access",
    "customer_uuid":"da90223725c74ee4b02524a3f3732321",
    "customer_name":"Ashley and Sons"
  }
]

Note: A LEXIS link can be in one of the following states:

  1. Pending
  2. Executing
  3. OK
  4. Erred

Listing LEXIS links can alternatively be done through Waldur UI by visiting resource details

LEXIS link view on the resource page

or use administration menu if you are a staff user

LEXIS links view on the admin page

To list all resources supporting LEXIS links, the following API request can be used:

1
http GET https://waldur.example.com/api/marketplace-resources/?lexis_links_supported=true Authorization:"Token 154f2c6984b5992928b62f87950ac529f1f906ca"

The main filter is lexis_links_supported parameter.

The example response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
HTTP/1.1 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 4825
Content-Type: application/json
Date: Wed, 31 Jan 2024 13:48:54 GMT
Link: <https://waldur.example.com/api/marketplace-resources/?lexis_links_supported=true>; rel="first", <https://waldur.example.com/api/marketplace-resources/?lexis_links_supported=true>; rel="last"
Server: WSGIServer/0.2 CPython/3.11.5
Vary: Accept, Accept-Language, Cookie, Origin
X-Frame-Options: DENY
X-Result-Count: 2

[
    {
        "attributes": {
            "name": "br1"
        },
        "available_actions": [
            "LEXIS_LINK.CREATE"
        ],
        "backend_id": "project_000003",
        "backend_metadata": {},
        "can_terminate": true,
        "category_icon": "https://waldur.example.com/api/media-download/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3IiOiIzYzY0ODg5ZjE2OTQ0MmQ2ODc0OTBhZGRjMmE5ZGUzMCIsImN0IjoibWFya2V0cGxhY2UuY2F0ZWdvcnkiLCJpZCI6IjQ3NDZjYWY4NTk0NzQwYjlhNWM4Y2I3OWE1ZGZkNThjIiwiZmllbGQiOiJpY29uIiwiZXhwIjoxNzA2NzEyNTM0fQ.d1oe4Yn5DcB2nEqHjWp-TQzYt0f2gmkJwO_SS3ArJms/",
        "category_title": "HPC",
        "category_uuid": "4746caf8594740b9a5c8cb79a5dfd58c",
        "created": "2022-12-15T20:35:48.855341Z",
        "current_usages": {},
        "customer_name": "Remote project",
        "customer_uuid": "b559b279ee9f47a788f64ac4b86d1c56",
        "description": "",
        "effective_id": "",
        "end_date": null,
        "end_date_requested_by": null,
        "endpoints": [],
        "error_message": "",
        "error_traceback": "",
        "is_limit_based": false,
        "is_usage_based": false,
        "limit_usage": null,
        "limits": {
          "gb_k_hours": 30,
          "cpu_k_hours": 1,
          "gpu_k_hours": 20
        },
        "modified": "2023-10-09T11:17:30.214126Z",
        "name": "br1",
        "offering": "https://waldur.example.com/api/marketplace-public-offerings/765868848dd943e0baeefdac9a78aeac/",
        "offering_billable": true,
        "offering_customer_uuid": "b559b279ee9f47a788f64ac4b86d1c56",
        "offering_description": "",
        "offering_image": null,
        "offering_name": "Basic",
        "offering_plugin_options": {
            "heappe_cluster_id": 1,
            "heappe_local_base_path": "~/",
            "heappe_url": "https://heappe-1.cloud.ut.ee",
            "heappe_username": "admin"
        },
        "offering_shared": true,
        "offering_terms_of_service": "",
        "offering_thumbnail": null,
        "offering_type": "Marketplace.Basic",
        "offering_uuid": "765868848dd943e0baeefdac9a78aeac",
        "options": null,
        "plan": "https://waldur.example.com/api/marketplace-public-offerings/765868848dd943e0baeefdac9a78aeac/plans/6e08a30d481b4d62a17a2c145d744d9e/",
        "plan_description": "",
        "plan_name": "asd plan",
        "plan_unit": "month",
        "plan_uuid": "6e08a30d481b4d62a17a2c145d744d9e",
        "project": "https://waldur.example.com/api/projects/dcc1e4456ba94f2498cf85dace03d1f4/",
        "project_description": "",
        "project_end_date": null,
        "project_end_date_requested_by": null,
        "project_name": "Local project / Local project 14",
        "project_uuid": "dcc1e4456ba94f2498cf85dace03d1f4",
        "provider_name": "Remote project",
        "provider_uuid": "b559b279ee9f47a788f64ac4b86d1c56",
        "report": null,
        "requested_downscaling": false,
        "resource_type": null,
        "resource_uuid": null,
        "scope": null,
        "state": "OK",
        "url": "https://waldur.example.com/api/marketplace-resources/f70a26bf348348a085d7b1276b473bcc/",
        "username": null,
        "uuid": "f70a26bf348348a085d7b1276b473bcc"
    }
]

To delete a LEXIS link the API request shown below can be sent.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
http DELETE https://waldur.example.com/api/lexis-links/3bb9fbdce9aa4602860fbedf94d9fb17/
Accept: application/json, text/plain, */*
Accept-Language: en
Authorization: Token e63ffc6408afc4ft874fc5fb4dbcebf1277ca723
HTTP/1.1 204 No Content
Date: Mon, 23 Oct 2023 08:56:48 GMT
Vary: Accept, Accept-Language, Cookie, Origin
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
X-Frame-Options: DENY
Content-Length: 0
Content-Language: en
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: x-result-count, Link

This can alternatively be done using Waldur UI: LEXIS link delete LEXIS link deletion submit

Integrating Open OnDemand with Waldur and SLURM

Components used

Open OnDemand is an open source software that empowers students, researchers, and industry professionals with remote web access to supercomputers.

Waldur is an open source platform for running HPC and Cloud self service.

SLURM is an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters.

Keycloak is an open source software product to allow single sign-on with identity and access management aimed at modern applications and services.

MyAccessID (optional) Identity and Access Management Service is provided by GEANT with the purpose of offering a common Identity Layer for Infrastructure Service Domains (ISDs).

Integration overview

flowchart TD
    User[👤 Local or federated user] --> Keycloak[🔐 Keycloak<br/>Identity Server]

    Keycloak --> Waldur[🏛️ Waldur<br/>Management Platform]
    Keycloak --> OOD[💻 Open OnDemand<br/>Web Interface]

    LDAP[📋 Existing LDAP<br/>User Directory] --> LDAPService[🔧 LDAP Microservice]
    LDAPService --> |SSSD-LDAP connect| SLURM[⚡ SLURM Cluster]
    LDAPService --> |SSSD-LDAP connect| OOD

    Waldur --> |Pulls users| LDAPService

    Agent[🤖 Waldur Site Agent<br/>Resource Manager] --> |Pushes usages| Waldur
    Agent --> |Pulls accounts| Waldur
    Agent --> |Creates accounts| SLURM
    Agent --> |Connects via SSH and launches jobs| SLURM

    OOD --> |SSSD-LDAP connect| LDAPService

    classDef user fill:#e1f5fe,stroke:#0277bd,stroke-width:2px
    classDef waldur fill:#c8e6c9,stroke:#388e3c,stroke-width:2px
    classDef external fill:#fff3e0,stroke:#f57c00,stroke-width:2px
    classDef infrastructure fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px

    class User user
    class Waldur,LDAPService,Agent waldur
    class LDAP,SLURM external
    class Keycloak,OOD infrastructure

OOD requirements

  • Shared user directory storage available both on SLURM and OOD VMs
  • Dedicated hostname for OOD machine (like ood.example.com)
  • Open TCP/80 and TCP/443, ability to connect LDAP on SLURM management machine
  • Linux server with at least 4GB of RAM and 10GB of storage disk

Open OnDemand (OOD) installation and configuration

Follow the guide at https://github.com/OSC/ood-ansible to automatically install OOD on the Linux server.

Preparation guide:

  1. Setup a certificate to later use in ansible configuration:
1
2
apt-get update && apt-get install certbot
certbot certonly --agree-tos -d ood.example.com --standalone -m ood@example.com --no-eff-email
  1. In Keycloak create a client with authentication enabled for the Open OnDemand.
  2. Populate the ansible inventory.yaml:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
---
all:
  children:
    playground:
      hosts:
        ood.example.com:
          ansible_user: ubuntu
      vars:
        servername: ood.example.com
        ssl:
          - SSLCertificateFile /etc/letsencrypt/live/ood.example.com/cert.pem
          - SSLCertificateKeyFile /etc/letsencrypt/live/ood.example.com/privkey.pem
          - SSLCertificateChainFile /etc/letsencrypt/live/ood.example.com/chain.pem
        oidc_settings_samefile: On
        oidc_provider_metadata_url: https://KEYCLOAK_IP/auth/realms/kcrealm/.well-known/openid-configuration
        oidc_client_id: OIDC_CLIENT
        oidc_client_secret: OIDC_SECRET
        oidc_remote_user_claim: preferred_username
        oidc_scope: "openid profile email"
        oidc_session_inactivity_timeout: 28800
        oidc_session_max_duration: 28800
        oidc_state_max_number_of_cookies: "10 true"
        oidc_cookie_same_site: On
        oidc_uri: "/oidc"
        httpd_auth:
          - AuthType openid-connect
          - Require valid-user
  1. Apply the playbook:
1
ansible-playbook -i inventory.yaml -D ood.yml

User authentication flow

  1. OOD gets Linux username from preferred_username claim from Keycloak

  2. OOD launches a "Per User Nginx" (PUN) environment after success user login

  3. OOD connects to a SLURM cluster with the selected preferred_username

flowchart LR
    User[👤 User] --> |Authenticates| OOD[💻 OOD starts per-user<br/>environment on the VM]
    OOD --> |Logins as the specific user| SLURM[⚡ SLURM login node]

    classDef user fill:#e1f5fe,stroke:#0277bd,stroke-width:2px
    classDef system fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
    classDef cluster fill:#fff3e0,stroke:#f57c00,stroke-width:2px

    class User user
    class OOD system
    class SLURM cluster

Keycloak configuration

Keycloak acts as a central Identity server for Waldur and Open OnDemand.

Steps to configure Keycloak:

alt_text

  1. Configure Waldur and Open Ondemand clients

alt_text

  1. Configure identity federation or user self-registration. If identity federation is used, common task is to configure username mapping like mentioned in https://puhuri.neic.no/idp_integration/use-cases/keycloak-integration/

alt_text

  1. Install waldur-username-mapper for matching Keycloak or federated users with their respective Linux usernames: https://docs.waldur.com/integrations/waldur-keycloak-mapper/

Open OnDemand cluster configuration

To configure the connection between Open OnDemand and SLURM you need to manually configure the cluster config /etc/ood/config/clusters.d/my_cluster.yml:

1
2
3
4
5
6
7
8
9
---
v2:
  metadata:
    title: my_slurm
  login:
    host: 172.16.1.2
  job:
    adapter: slurm
    submit_host: 172.16.1.2

Waldur Site Agent configuration

Waldur Site Agent is a microservice for pulling allocation from Waldur and pushing the allocation usage statistics back to Waldur.

The microservice supports 2 modes of operation:

  1. Docker Compose - testing only, requires SLURM running in the same docker compose
  2. Native - production

Follow Waldur Site Agent documentation for installation guide. Make sure to enable the enable_user_homedir_account_creation flag - Open OnDemand does not work unless the user's home directory exists.

Host-based SSH authentication configuration

One of the methods to allow OOD to connect to SLURM login node is to setup a host-based “trust” or “SSH host-based authentication” between OOD VM and SLURM login node.

Use https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Host-based_Authentication as a guide.

Troubleshooting

  1. OOD login and preferredUsername fetching errors are located in /var/log/httpd/error.log or similar
  2. Per user application or SLURM configuration errors are located in /var/log/ondemand-nginx/USERNAME/
  3. By default, OOD does not well tolerate setting arbitrary prepends for the URL — prefer using https://ood.example.com instead of https://ood.example.com/
  4. Most common SSSD / LDAP configuration errors include:
    1. Wrong LDAP filter
    2. SSSD is not able to reach LDAP server (network error)
    3. SSSD installed without sssd-ldap plugin
    4. Home directory of the user has not been created
  5. Make sure to specify correct SLURM account in the OOD job configuration:

slurm-account

Service Desk integrations

Waldur supports integrations with several widely used service desk solutions. Integration allows creation of support requests directly from Waldur. In addition, replies from the support personnel are synchronised with Waldur so that the end users are never directly exposed to the service desk software. Users can see the issues' history, current status of active tickets as well as are able to interact with tickets from within Waldur.

Currently supported service desk solutions:

Waldur Keycloak mapper

This repository contains custom Keycloak OIDC protocol mappers that integrate with Waldur (cloud platform) to provide dynamic user authentication and authorization capabilities. The mappers enable seamless integration between Keycloak identity provider and Waldur's permission system.

Waldur OfferingUser username mapper

Goal

Maps Keycloak users to their corresponding usernames in Waldur offerings, enabling consistent user identification across systems.

Capabilities

  • Dynamic Username Resolution: Retrieves the preferred username for a user from Waldur's marketplace offering users API
  • Token Integration: Adds the resolved username as a custom claim in OIDC tokens (ID token, access token, and user info)
  • Offering-Specific Mapping: Configurable per offering UUID to support different username schemes across offerings
  • Secure API Communication: Supports both TLS-validated and non-validated connections to Waldur API
  • Error Handling: Graceful handling of API failures with comprehensive logging

Configuration Parameters

  • Waldur API URL: Base URL to Waldur API (e.g., https://waldur.example.com/api/)
  • Offering UUID: Specific offering identifier in Waldur
  • API Token: Authentication token for Waldur API access
  • TLS Validation: Enable/disable TLS certificate validation
  • Claim Name: Custom name for the token claim containing the username

Waldur Offering access mapper

Goal

Dynamically manages Keycloak group memberships and role assignments based on user access permissions in Waldur offerings.

Capabilities

  • Dynamic Access Control: Checks user access to specific Waldur offerings in real-time
  • Group Management: Automatically adds/removes users from Keycloak groups based on offering access
  • Role Assignment: Grants or revokes Keycloak roles based on offering permissions
  • Bidirectional Sync: Both grants access when user has permissions and revokes when access is lost
  • Flexible Username Sources: Supports both Keycloak user ID and username for Waldur API calls
  • Token Claims: Optionally adds group information to OIDC tokens

Configuration Parameters

  • Waldur API URL: Base URL to Waldur API
  • Offering UUID: Target offering identifier for access checks
  • API Token: Waldur API authentication token
  • Username Source: Choose between Keycloak user ID or username (id or username)
  • Group Management:
  • Group name to manage
  • Enable/disable automatic group addition
  • Role Management:
  • Role name to grant/revoke
  • Enable/disable automatic role assignment
  • Claim Name: Custom token claim for group information

Use Cases

  • Service Access Control: Automatically grant access to services based on Waldur offering subscriptions
  • Team Management: Sync team memberships between Waldur and Keycloak
  • Resource Permissions: Map Waldur resource access to Keycloak authorization

Waldur MinIO mapper

Goal

Generates MinIO-compatible policy claims for object storage access control based on user permissions in Waldur.

Capabilities

  • Permission Aggregation: Collects user permissions from Waldur across different scope types
  • Policy Generation: Creates comma-separated lists of resource UUIDs for MinIO policies
  • Scope-Based Filtering: Supports both customer and project scope types for permission queries
  • Role-Based Access: Filters permissions by user roles (owner, manager, etc.) within each scope
  • Token Integration: Embeds policy information directly in OIDC tokens for MinIO consumption
  • Flexible Username Sources: Supports both Keycloak user ID and username for API authentication
  • Secure Communication: Configurable TLS validation for API calls

Configuration Parameters

  • Waldur API URL: Base URL to Waldur API
  • API Token: Waldur API authentication token
  • Permission Scope: Choose between customer or project scope types
  • TLS Validation: Enable/disable certificate validation
  • Username Source: Use Keycloak user ID or username for API calls
  • Claim Name: Token claim name for the policy data

Example Output

For a user who is an owner in customers C1, C2 and manager in projects P1, P2:

Customer scope: policy=c1-uuid-here,c2-uuid-here Project scope: policy=p1-uuid-here,p2-uuid-here

MinIO Integration

The generated policy claims can be used by MinIO to: - Bucket Access Control: Grant access to buckets based on customer/project membership - Object-Level Permissions: Control file access within buckets - Dynamic Policy Updates: Automatically update access as Waldur permissions change

Building from Source

Prerequisites

  • Java 8 or higher: The project is compiled with Java 8 target compatibility
  • Apache Maven 3.6+: Required for building and dependency management
  • Git: For cloning the repository

Build Instructions

  1. Clone the repository:
1
2
git clone https://github.com/waldur/waldur-keycloak-mapper.git
cd waldur-keycloak-mapper
  1. Build the JAR file:
1
mvn clean install

This will: - Download all required dependencies - Compile the Java source code - Run any tests (if present) - Create a shaded JAR with all dependencies included - Place the built JAR in the target/ directory

  1. Locate the built JAR:

The compiled JAR file will be available at:

1
target/waldur-keycloak-mapper-{version}.jar

Build Options

  • Clean build: Remove previous build artifacts before building
1
mvn clean install
  • Skip tests: Build without running tests (if any)
1
mvn clean install -DskipTests
  • Custom version: Build with a specific version number
1
mvn clean install -Drevision=1.2.3

Development Environment

For development, you can use any Java IDE that supports Maven projects:

  • IntelliJ IDEA: Import as Maven project
  • Eclipse: Import existing Maven project
  • VS Code: Use Java Extension Pack with Maven support

The project uses Maven's standard directory layout: - src/main/java/: Java source files - src/main/resources/: Resource files and service registration - target/: Build output directory

Installation and setup

Custom mapper setup includes the following steps:

  1. Download the jar file to your machine, e.g. one of these releases.

  2. Add the jar file to the providers directory. If a Keycloak server is running in a Docker container via Docker Compose, you can mount the file as a volume:

    1
2
3
4
5
6
7
8
    keycloak:
image: "quay.io/keycloak/keycloak:18.0.2"
container_name: keycloak
command: start-dev --http-relative-path /auth
ports:
    - "${KEYCLOAK_PORT:-8080}:8080"
volumes:
    - waldur-keycloak-mapper-1.0.jar:/opt/keycloak/providers/waldur-keycloak-mapper-1.0.jar

  3. Restart the deployment to apply the changes.

  4. You can find the mapper in client menu under "Mappers" section. The title is "Waldur preferred username mapper"

Waldur MCP server

Waldur MCP server enables integration between Waldur instance and Claude Desktop by implementing the Model Context Protocol (MCP). This allows Claude to interact with your Waldur instance directly.

Quickstart

  1. Install Claude Desktop for your platform from the Claude Desktop releases page

  2. Install Python 3.13 or higher.

  3. Install uv package manager.

Installation

To install the package:

1
pip install waldur-mcp-server

Or with uv:

1
uv pip install waldur-mcp-server

Generate Waldur Token

  1. Log in to your Waldur instance
  2. Navigate to Username > Credentials > API Token
  3. Generate a new token with appropriate token lifetime - you'll need it for configuration

Claude Desktop MCP Server Configuration

On Windows: %APPDATA%\Claude\claude_desktop_config.json

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "mcpServers": {
    "waldur-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "C:\\waldur_service",
        "run",
        "waldur-mcp-server"
      ],
      "env": {
        "WALDUR_API_URL": "https://your-waldur-instance",
        "WALDUR_TOKEN": "your-token"
      }
    }
  }
}
Published Servers Configuration 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "mcpServers": {
    "waldur-mcp-server": {
      "command": "uvx",
      "args": [
        "waldur-mcp-server"
      ],
      "env": {
        "WALDUR_API_URL": "https://your-waldur-instance",
        "WALDUR_TOKEN": "your-token"
      }
    }
  }
}

Debugging

On macOS, log files are located at ~/Library/Logs/Claude/mcp.log

If you encounter a spawn uvx ENOENT error, verify that your PATH environment variable includes the Python installation directory where uv is installed. Alternatively, you can specify the full path to uvx in the configuration file, for example: ~/Library/Frameworks/Python.framework/Versions/3.13/bin/uvx

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

1
npx @modelcontextprotocol/inspector uv --directory C:\\waldur_service run waldur-mcp-server

When debugging, you'll need to set the required environment variables. Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Common issues

  • Invalid token: Verify token permissions and expiration
  • Connection issues: Check WALDUR_API_URL is accessible

Ended: Integrations

Integrator guide ↵

Ansible Waldur Module Generator

This project is a code generator designed to automate the creation of a self-contained Ansible Collection for the Waldur API. By defining a module's behavior and its API interactions in a simple YAML configuration file, you can automatically generate robust, well-documented, and idempotent Ansible modules, perfectly packaged for distribution and use.

The primary goal is to eliminate boilerplate code, enforce consistency, and dramatically speed up the development process for managing Waldur resources with Ansible. Waldur Ansible Collection is published on Ansible Galaxy.

Core Concept

The generator works by combining three main components:

  1. OpenAPI Specification (waldur_api.yaml): The single source of truth for all available API endpoints, their parameters, and their data models.
  2. Generator Configuration (generator_config.yaml): A user-defined YAML file where you describe the Ansible Collection and the modules you want to create. This is where you map high-level logic (like "create a resource") to specific API operations.
  3. Plugins: The engine of the generator. A plugin understands a specific workflow or pattern (e.g., fetching facts, simple CRUD, or complex marketplace orders) and contains the logic to build the corresponding Ansible module code.

Getting Started

Prerequisites

  • Python 3.11+
  • Poetry (for dependency management and running scripts)
  • Ansible Core (ansible-core >= 2.14) for building and using the collection.

Installation

  1. Clone the repository: 

    1
2
    git clone <your-repo-url>
cd ansible-waldur-generator

  2. Install the required Python dependencies using Poetry: 

    1
    poetry install
    This will create a virtual environment and install packages like PyYAML, and Pytest.

Running the Generator

To generate the Ansible Collection, run the generate script defined in pyproject.toml:

1
poetry run ansible-waldur-generator

By default, this command will:

  • Read inputs/generator_config.yaml and inputs/waldur_api.yaml.

  • Use the configured collection name (e.g., waldur.openstack) to create a standard Ansible Collections structure.

  • Place the generated collection into the outputs/ directory.

The final structure will look like this: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
outputs/
└── ansible_collections/
    └── waldur/
        ├── structure/          # Collection 1
        │   ├── galaxy.yml
        │   ├── plugins/
        │   │   ├── modules/
        │   │   │   ├── customer.py
        │   │   │   └── project.py
        │   │   └── module_utils/
        │   └── ...
        ├── openstack/          # Collection 2
        │   ├── galaxy.yml
        │   ├── plugins/
        │   │   ├── modules/
        │   │   │   ├── volume.py
        │   │   │   └── security_group.py
        │   │   └── module_utils/
        │   └── ...
        └── slurm/              # Collection 3
            ├── galaxy.yml
            └── ...

You can customize the path using command-line options: 

1
poetry run generate --config my_config.yaml --output-dir ./dist
Run poetry run ansible-waldur-generator --help for a full list of options.

The Plugin System

The generator uses a plugin-based architecture to handle different types of module logic. Each plugin is specialized for a common interaction pattern with the Waldur API. When defining a module in generator_config.yaml, the type key determines which plugin will be used.

The header defines Ansible collection namespace, name and version.

1
2
3
4
5
6
7
collections:
  - namespace: waldur
    name: structure
    version: 1.0.0
    modules:
      - name: modename
        plugin: crud

Below is a detailed explanation of each available plugin.

1. The facts Plugin

  • Purpose: For creating read-only Ansible modules that fetch information about existing resources. These modules never change the state of the system and are analogous to Ansible's _facts modules (e.g., setup_facts).

  • Workflow:

    1. The module's primary goal is to find and return resource data based on an identifier (by default, name).
    2. If the many: true option is set, the module returns a list of all resources matching the filter criteria.
    3. If many: false (the default), the module expects to find a single resource. It will fail if zero or multiple resources are found, prompting the user to provide a more specific identifier.
    4. It can be configured with context_params (like tenant or project) to filter the search within a parent resource.

  • Configuration Example (generator_config.yaml): This example creates a waldur_openstack_security_group_facts module to get information about security groups within a specific tenant.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
    modules:
  - name: security_group_facts
    plugin: facts
    resource_type: "security group"
    description: "Get facts about OpenStack security groups."

    # Defines the base prefix for API operations. The 'facts' plugin uses
    # this to automatically infer the necessary operation IDs:
    #  - `check`: via `openstack_security_groups_list`
    #  - `retrieve`: via `openstack_security_groups_retrieve`
    # The 'operations' block is therefore not needed for a conventional API.
    base_operation_id: "openstack_security_groups"

    # If `true`, the module is allowed to return a list of multiple resources
    # that match the filter criteria.
    # If `false` (the default), the module would fail if more than one
    # resource is found, ensuring a unique result.
    many: true

    # Defines additional parameters that can be used to filter the search.
    # This is essential for finding resources within a specific scope.
    context_params:
      - # The name of the Ansible parameter the user will provide.
        name: "tenant"
        description: "The name or UUID of the tenant to filter security groups by."

        # Tells the generator how to resolve the user-provided 'tenant' name
        # into the UUID needed by the API. The string "openstack_tenants" is
        # a shorthand that expands to the standard list/retrieve operations for tenants.
        resolver: "openstack_tenants"

        # Specifies the exact query parameter key to use when calling the 'check'
        # operation. The generator will construct a query like:
        # `?tenant_uuid=<resolved_tenant_uuid>`
        filter_key: "tenant_uuid"

2. The crud Plugin

  • Purpose: For managing the full lifecycle of resources with simple, direct, synchronous API calls. This is ideal for resources that have distinct create, list, update, and destroy endpoints. The plugin supports both top-level resources (like projects) and nested resources (like security groups under a tenant).

  • Workflow:

    • state: present:
      1. Calls the list operation to check if a resource with the given name already exists.
      2. If it does not exist, it calls the create operation. resolvers and path_param_maps are used to convert parent resource names into the required API URLs or path UUIDs.
      3. If it does exist, it checks for changes:
        • It compares values for parameters listed in update_config.fields and sends a PATCH request via the update operation if any have changed.
        • It checks if any parameters for special update_config.actions are provided and calls their respective POST operations.
          • Asynchronous Actions: If the POST action returns a 202 Accepted status code, the module recognizes it as an asynchronous task.
          • If the wait: true parameter is set (the default), the module will poll the resource's status until it reaches a stable state (e.g., "OK" or "ERRED").
          • You can configure the stable/error states and polling parameters in generator_config.yaml.
    • state: absent:
      1. Calls the list operation to find the resource.
      2. If it exists, it calls the destroy operation to remove it.

  • Return Values:

    • resource: A dictionary representing the final state of the resource after the operation.
    • commands: A list of dictionaries detailing the HTTP requests that were made to achieve the desired state. This is useful for auditing and debugging.
    • changed: A boolean indicating if any changes were made.

  • Configuration Example (generator_config.yaml): This example creates a security_group module that is a nested resource under a tenant, and supports both simple updates (description) and a special action (set_rules).

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    modules:
  - name: security_group
    plugin: crud
    resource_type: "OpenStack security group"
    description: "Manage OpenStack Security Groups and their rules in Waldur."

    # The core prefix for inferring standard API operation IDs.
    # By providing this, the generator automatically enables:
    #  - `check`: via `openstack_security_groups_list`
    #  - `delete`: via `openstack_security_groups_destroy`
    base_operation_id: "openstack_security_groups"

    # The 'operations' block is now only for EXCEPTIONS and detailed configuration.
    # Since 'check' and 'delete' follow the convention, they are omitted here.
    operations:

        # Defines special, non-standard update actions that call dedicated
        # POST endpoints. These are idempotent and schema-aware.
        actions:
          # 'set_rules' is the logical name for our action.
          set_rules:
            # The specific operationId to call when this action is triggered.
            operation: "openstack_security_groups_set_rules"
            # The name of the Ansible parameter that triggers this action and
            # provides its data. The runner will only call the operation if
            # the user provides the 'rules' parameter AND its value differs
            # from the resource's current state.
            param: "rules"

      # Override the 'create' operation.
      # This is necessary because creating a security group is a NESTED action
      # under a tenant, so it doesn't follow the standard '[base_id]_create' pattern.
      create:
        id: "openstack_tenants_create_security_group"

        # This block is crucial for nested endpoints. It maps the placeholder
        # in the API URL path (`/api/openstack-tenants/{uuid}/...`) to the
        # name of an Ansible parameter (`tenant`).
        path_params:
          uuid: "tenant"

    wait_config:
      ok_states: ["OK"] # The state(s) that mean success
      erred_states: ["ERRED"] # The state(s) that mean failure
      state_field: "state" # The key in the resource dict that holds the state

    # This block defines how to resolve dependencies.
    resolvers:
      # We need a resolver for 'tenant' because it's used in `path_params` for
      # the 'create' operation. This tells the generator how to convert the
      # user-friendly tenant name or UUID into the internal API URL/UUID
      # needed for the API call.
      tenant: "openstack_tenants" # Shorthand for the tenants resolver

3. The order Plugin

  • Purpose: The most powerful and specialized plugin, designed for resources managed through Waldur's asynchronous marketplace order workflow. This is the correct plugin for nearly all major cloud resources like VMs, volumes, databases, etc.

Attribute Inference: To simplify configuration, you can specify an offering_type. The generator will then look for a corresponding schema in the OpenAPI specification (e.g., Marketplace.Volume becomes MarketplaceVolumeCreateOrderAttributes) and automatically generate all the necessary attribute_params. Any manually defined attribute_params will override the inferred ones, allowing for customization.

Termination Attributes: You can define a set of optional parameters that will be passed as attributes in the termination order. This is useful for resources that require extra options during deletion, such as forcing destruction or deleting associated sub-resources. This is configured under the operations.delete key. You can use the maps_to field to define a different name for the attribute in the API payload.

  • Workflow: This plugin encapsulates a complex, multi-step process:

    • state: present:
      1. Checks for the existence of the final resource (e.g., the volume) using existence_check_op.
      2. If it does not exist, it creates a marketplace order via marketplace_orders_create and, if wait: true, polls for completion.
      3. If it does exist, it checks for changes. It supports two kinds of updates:
        • Synchronous Updates: For simple fields inferred from update request schema, it sends a direct PATCH request.
        • Asynchronous Actions: For complex operations defined in update_actions, it sends a POST request. If this request returns a 202 Accepted status, the module recognizes it as an asynchronous task. If wait: true is set, the module will then poll the resource's status (not the order) until it reaches a stable state (e.g., "OK" or "Erred"), which can be configured via wait_config.
    • state: absent:
      1. Finds the existing resource.
      2. Calls the standard marketplace_resources_terminate endpoint, passing any configured termination attributes.

  • Return Values:

    • resource: A dictionary representing the final state of the resource after a successful operation.
    • commands: A list of dictionaries detailing the HTTP requests that were made.
    • changed: A boolean indicating if any changes were made.

  • Configuration Example (generator_config.yaml):

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    modules:
  - name: volume
    plugin: order
    resource_type: "OpenStack volume"
    description: "Create, update, or delete an OpenStack Volume via the marketplace."

    # By specifying the offering type, the generator will automatically find the
    # corresponding schema in the OpenAPI specification (e.g., for volume size,
    # image, etc.) and generate all the necessary Ansible parameters.
    # This dramatically reduces the amount of manual configuration required.
    offering_type: "OpenStack.Volume"

    # The base prefix for inferring standard API operation IDs.
    # The 'order' plugin uses this to automatically enable:
    #  - `check`: via `openstack_volumes_list` (to see if the volume already exists)
    base_operation_id: "openstack_volumes"

    # This block defines how to resolve dependencies and filter choices for the
    # module's parameters.
    resolvers:
      # This resolver is for the 'type' parameter, which was automatically
      # inferred from the offering_type schema.
      type:
        # Shorthand for the volume types API endpoints.
        base: "openstack_volume_types"
        # This is a powerful feature for dependent filtering. It tells the
        # generator to filter the list of available volume types based on
        # the cloud settings of the selected 'offering'.
        filter_by:
          - # The parameter whose resolved value we will use as the filter source.
            source_param: "offering"
            # The key to extract from the resolved offering's API response.
            source_key: "scope_uuid"
            # The query parameter to use when listing volume types. The final
            # API call will be something like:
            # `.../openstack-volume-types/?tenant_uuid=<offering_scope_uuid>`
            target_key: "tenant_uuid"

      # The same dependent filtering pattern is applied to the 'image' parameter.
      image:
        base: "openstack_images"
        filter_by:
          - source_param: "offering"
            source_key: "scope_uuid"
            target_key: "tenant_uuid"

      # And again for the 'availability_zone' parameter.
      availability_zone:
        base: "openstack_volume_availability_zones"
        filter_by:
          - source_param: "offering"
            source_key: "scope_uuid"
            target_key: "tenant_uuid"

4. The actions Plugin

  • Purpose: For creating modules that execute specific, one-off actions on an existing resource. This is ideal for operations that don't fit the standard CRUD lifecycle, such as reboot, connect, pull, or start. These modules are essentially command runners for your API.

  • Workflow:

    1. The module first finds the target resource using an identifier (e.g., name) and optional context_params. It will fail if the resource is not found.
    2. It then executes a POST request to the API endpoint corresponding to the user-selected action.
    3. The module always reports changed=True upon successful execution of an action.
    4. It re-fetches the resource's state after the action and returns it, allowing users to see the result of the command.

  • Configuration Example (generator_config.yaml): This example creates a subnet_action module to connect or disconnect a subnet in OpenStack.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    modules:
  - name: subnet_action
    plugin: actions
    resource_type: "OpenStack subnet"
    description: "Perform actions on OpenStack Subnets."

    # The base operation ID used to infer `_list`, `_retrieve`, and action operations.
    # For example, 'connect' becomes 'openstack_subnets_connect'.
    base_operation_id: "openstack_subnets"

    # A list of action names. The generator infers the full `operationId` for each
    # action by appending the name to the `base_operation_id` (e.g.,
    # `base_operation_id: "openstack_subnets"` and action `"connect"` becomes
    # `openstack_subnets_connect`). These names become the choices for the
    # module's `action` parameter.
    actions:
      - connect
      - disconnect
      - pull

    # Optional context parameters to help locate the resource.
    context_params:
      - name: "tenant"
        description: "The name or UUID of the tenant to filter subnets by."
        resolver: "openstack_tenants"
        filter_key: "tenant_uuid"

Reusable Configuration with YAML Anchors

As your generator_config.yaml file grows, you'll notice that certain configurations, especially for resolvers or update_config, are repeated across multiple modules. To keep your configuration DRY (Don't Repeat Yourself) and improve maintainability, you can use a standard YAML feature called anchors (&) and aliases (*).

The generator's YAML parser supports this out of the box, allowing you to define a configuration block once and reuse it wherever needed.

A common convention is to create a top-level key (e.g., definitions or x-fragments) to hold your reusable blocks.

Example 1: Reusing a Common Resolver

Imagine you have two modules that both need to resolve a tenant.

Before (Repetitive Configuration):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
collections:
  - namespace: waldur
    name: openstack
    version: 1.0.0
    modules:
      - name: security_group
        plugin: crud
        resource_type: "security group"
        # ... other config ...
        resolvers:
          tenant:
            list: "openstack_tenants_list"
            retrieve: "openstack_tenants_retrieve"
            error_message: "Tenant '{value}' not found."

      - name: volume_facts
        plugin: facts
        resource_type: "volume"
        # ... other config ...
        context_params:
          - name: "tenant"
            description: "The tenant to filter volumes by."
            resolver:
              list: "openstack_tenants_list"
              retrieve: "openstack_tenants_retrieve"
              filter_key: "tenant_uuid"

After (Using a Reusable Anchor):

We define the resolver once under a definitions key and give it an anchor &tenant_resolver. Then, we use the alias *tenant_resolver to insert that block in multiple places.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Define reusable configuration blocks at the top level.
definitions:
  # This entire block is now anchored with the name 'tenant_resolver'.
  tenant_resolver: &tenant_resolver
    list: "openstack_tenants_list"
    retrieve: "openstack_tenants_retrieve"
    error_message: "Tenant '{value}' not found."

collections:
  - namespace: waldur
    name: openstack
    version: 1.0.0
    modules:
      - name: security_group
        plugin: crud
        resource_type: "security group"
        # ... other config ...
        resolvers:
          # Use the alias '*' to insert the anchored block here.
          tenant: *tenant_resolver

      - name: volume_facts
        plugin: facts
        resource_type: "volume"
        # ... other config ...
        context_params:
          - name: "tenant"
            description: "The tenant to filter volumes by."
            # The alias works for nested keys too.
            resolver: *tenant_resolver
            filter_key: "tenant_uuid"

Example 2: Creating a Reusable Module Template

You can make entire module definitions reusable by combining anchors with the YAML merge key (<<). This allows you to define a "base" module and then override or extend it for specific cases.

This is perfect for a set of simple CRUD resources that share the same plugin type and update logic but differ only in their resource_type and API base_operation_id.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
definitions:
  # Define a base template for a simple CRUD module.
  base_crud_module: &base_crud_module
    plugin: crud
    update_config:
      fields:
        - "name"
        - "description"

collections:
  - namespace: waldur
    name: structure
    version: 1.0.0
    modules:
      - name: customer
        # The '<<: *base_crud_module' line merges the anchored block.
        # Keys defined here will override any from the base template.
        <<: *base_crud_module
        resource_type: "customer"
        base_operation_id: "customers"
        description: "Manage Customers in Waldur."

      - name: project
        <<: *base_crud_module
        resource_type: "project"
        base_operation_id: "projects"
        description: "Manage Projects in Waldur."
        # You can also add keys that don't exist in the base template.
        resolvers:
          customer:
            list: "customers_list"
            retrieve: "customers_retrieve"
            error_message: "Customer '{value}' not found."

By using these standard YAML features, you can significantly reduce duplication and make your generator configuration cleaner and easier to manage.

Architecture

The generator's architecture is designed to decouple the Ansible logic from the API implementation details. It achieves this by using the generator_config.yaml as a "bridge" between the OpenAPI specification and the generated code. The generator can produce multiple, self-contained Ansible Collections in a single run.

graph TD
    subgraph "Inputs"
        B[waldur_api.yaml]
        A[generator_config.yaml]
    end

    subgraph "Engine"
        C{Generator Script}
        D[Generic Module <br>Template String]
    end

    subgraph "Output"
        E[Generated Ansible Module <br>project.py]
    end

    A --> C
    B --> C
    C -- Builds GenerationContext via Plugins --> D
    D -- Renders final code --> E

Plugin-Based Architecture

The system's flexibility comes from its plugin architecture. The Generator itself does not know the details of a crud module versus an order module. It only knows how to interact with the BasePlugin interface.

  1. Plugin Discovery: The PluginManager uses Python's entry point system to automatically discover and register plugins at startup.
  2. Delegation: The Generator reads a module's plugin key from the config and asks the PluginManager for the corresponding plugin.
  3. Encapsulation: Each plugin fully encapsulates the logic for its type. It knows how to parse its specific YAML configuration, interact with the ApiSpecParser to get operation details, and build the final GenerationContext needed to render the module.
  4. Plugin Contract: All plugins implement the BasePlugin interface, which requires a central generate() method. This ensures a consistent interaction pattern between the Generator and all plugins.

Runtime Logic (Runners and the Resolver)

The logic that executes at runtime inside an Ansible module is split between two key components: Runners and the ParameterResolver.

  1. Runners (runner.py): Each plugin is paired with a runner.py file (e.g., CrudRunner, OrderRunner). This runner contains the Python logic for the module's state management (create, update, delete). The generated module file (e.g., project.py) is a thin wrapper that calls its corresponding runner. The generator copies the runner and a base_runner.py into the collection's plugins/module_utils/ directory and rewrites their imports, making the collection fully self-contained.

  2. ParameterResolver: This is a powerful, centralized utility that is composed within each runner. Its sole responsibility is to handle the complex, recursive resolution of user-friendly inputs (like resource names) into the URLs or other data structures required by the API. By centralizing this logic, runners are kept clean and focused on their state-management tasks. The resolver supports:

    • Simple name/UUID to URL conversion.
    • Recursive resolution of nested dictionaries and lists.
    • Caching of API responses to avoid redundant network calls.
    • Dependency-based filtering (e.g., filtering flavors by the tenant of a resolved offering).

The "Plan and Execute" Runtime Model

While the generator builds the module code, the real intelligence lies in the runtime architecture it creates. All generated modules follow a robust, two-phase "plan and execute" workflow orchestrated by a BaseRunner class, which is vendored into the collection's module_utils.

  1. Planning Phase: The BaseRunner first determines the current state of the resource (does it exist?). It then calls a plan_* method (e.g., plan_creation, plan_update) corresponding to the desired state. This planning method does not make any changes to the system. Instead, it builds a list of Command objects. Each Command is a simple data structure that encapsulates a single, atomic API request (method, path, body).

  2. Execution Phase: If not in check mode, the BaseRunner iterates through the generated plan and executes each Command, making the actual API calls.

This separation provides key benefits: - Perfect Check Mode: Since the planning phase is purely declarative and makes no changes, check mode works perfectly by simply serializing the plan without executing it. - Clear Auditing: The final output of a module includes a commands key, which is a serialized list of the exact HTTP requests that were planned and executed. This provides complete transparency. - Consistency: All module types (crud, order) use the same underlying BaseRunner and Command structure, ensuring consistent behavior.

The diagram below illustrates this runtime workflow.

sequenceDiagram
    participant Ansible
    participant Generated Module
    participant Runner
    participant API

    Ansible->>+Generated Module: main()
    Generated Module->>+Runner: run()
    Runner->>Runner: check_existence()
    Runner->>API: GET /api/resource/?name=...
    API-->>Runner: Resource exists / does not exist

    Note over Runner: Planning Phase (No Changes)
    Runner->>Runner: plan_creation() / plan_update()
    Note over Runner: Builds a list of Command objects

    alt Check Mode
        Runner->>Generated Module: exit_json(changed=true, commands=[...])
    else Execution Mode
        Runner->>Runner: execute_change_plan()
        loop For each Command in plan
            Runner->>API: POST/PATCH/DELETE ...
            API-->>Runner: API Response
        end
        Runner->>Generated Module: exit_json(changed=true, resource={...}, commands=[...])
    end

    deactivate Runner
    Generated Module-->>-Ansible: Final Result

The Resolvers Concept: Bridging the Human-API Gap

At the heart of the generator's power is the Resolver System. Its fundamental purpose is to bridge the gap between a human-friendly Ansible playbook and the strict requirements of a machine-focused API.

  • The Problem: An Ansible user wants to write customer: 'Big Corp Inc.'. However, the Waldur API requires a full URL for the customer field when creating a new project, like customer: 'https://api.example.com/api/customers/a1b2-c3d4-e5f6/'. Asking users to find and hardcode these URLs is cumbersome, error-prone, and goes against the principle of declarative, readable automation.

  • The Solution: Resolvers automate this translation. You define how to find a resource (like a customer) by its name or UUID, and the generated module's runtime logic (the "runner") will handle the lookup and substitution for you.

This system is used by all plugins but is most critical for the crud and order plugins, which manage resource relationships. Let's explore how it works using examples from our generator_config.yaml.

Simple Resolvers

A simple resolver handles a direct, one-to-one relationship. It takes a name or UUID and finds the corresponding resource's URL. This is common for top-level resources or parent-child relationships.

  • Mechanism: It works by using two API operations which are inferred from a base string:

    1. A list operation to search for the resource by its name (e.g., customers_list with a name_exact filter).
    2. A retrieve operation to fetch the resource directly if the user provides a UUID (this is a performance optimization).

  • Configuration Example (from waldur.structure): This example configures resolvers for the customer and type parameters in the project module.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    # In generator_config.yaml
- name: project
  plugin: crud
  base_operation_id: "projects"
  resolvers:
    # Shorthand notation. This tells the generator:
    # 1. There is an Ansible parameter named 'customer'.
    # 2. To resolve it, use the 'customers_list' and 'customers_retrieve' API operations.
    customer: "customers"

    # Another example for the project's 'type'.
    type: "project_types"

  • Runtime Workflow: When a user runs a playbook with customer: "Big Corp", the project module's runner executes the following logic:

    sequenceDiagram
    participant User as Ansible User
    participant Module as waldur.structure.project
    participant Resolver as ParameterResolver
    participant Waldur as Waldur API

    User->>Module: Executes playbook with `customer: "Big Corp"`
    Module->>Resolver: resolve("customer", "Big Corp")
    Resolver->>Waldur: GET /api/customers/?name_exact="Big Corp" (via 'customers_list')
    Waldur-->>Resolver: Returns customer object `{"url": "...", "name": "Big Corp", ...}`
    Resolver-->>Module: Returns resolved URL: "https://.../customers/..."

    Module->>Waldur: POST /api/projects/ with body `{"customer": "https://.../customers/...", "name": "..."}`
    Waldur-->>Module: Returns newly created project
    Module-->>User: Success (changed: true)

Advanced Resolvers: Dependency Filtering

The true power of the resolver system shines when dealing with nested or context-dependent resources. This is essential for the order plugin.

  • The Problem: Many cloud resources are not globally unique. For example, an OpenStack "flavor" named small might exist in multiple tenants. To create a VM, you need the specific small flavor that belongs to the tenant where you are deploying. A simple name lookup is not enough.

  • The Solution: The order plugin's resolvers support a filter_by configuration. This allows one resolver's lookup to be filtered by the results of another, previously resolved parameter.

  • Configuration Example (from waldur.openstack): This instance module resolves a flavor. The list of available flavors must be filtered by the tenant, which is derived from the offering the user has chosen.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
    # In generator_config.yaml
- name: instance
  plugin: order
  offering_type: OpenStack.Instance
  # ...
  resolvers:
    # The 'flavor' resolver depends on the 'offering'.
    flavor:
      # Shorthand to infer 'openstack_flavors_list' and 'openstack_flavors_retrieve'
      base: "openstack_flavors"

      # This block establishes the dependency.
      filter_by:
        - # 1. Look at the result of the 'offering' parameter.
          source_param: "offering"
          # 2. From the resolved offering's API response, get the value of the 'scope_uuid' key.
          #    (In Waldur, this is the UUID of the tenant associated with the offering).
          source_key: "scope_uuid"
          # 3. When calling 'openstack_flavors_list', add a query parameter.
          #    The parameter key will be 'tenant_uuid', and its value will be the
          #    'scope_uuid' we just extracted.
          target_key: "tenant_uuid"

  • Runtime Workflow: This is a multi-step process managed internally by the runner and resolver.

    sequenceDiagram
    participant User as Ansible User
    participant Runner as OrderRunner
    participant Resolver as ParameterResolver
    participant Waldur as Waldur API

    Note over User, Runner: Playbook runs with `offering: "VMs in Tenant A"` and `flavor: "small"`

    Runner->>Resolver: resolve("offering", "VMs in Tenant A")
    Resolver->>Waldur: GET /api/marketplace-public-offerings/?name_exact=...
    Waldur-->>Resolver: Returns Offering object `{"url": "...", "scope_uuid": "tenant-A-uuid", ...}`
    Note right of Resolver: Caches the full Offering object internally.
    Resolver-->>Runner: Returns Offering URL

    Runner->>Resolver: resolve("flavor", "small")
    Note right of Resolver: Sees `filter_by` config for 'flavor'.
    Resolver->>Resolver: Looks up 'offering' in its cache. Finds the object.
    Resolver->>Resolver: Extracts `scope_uuid` ("tenant-A-uuid") from cached object.

    Note right of Resolver: Builds query: `?name_exact=small&tenant_uuid=tenant-A-uuid`
    Resolver->>Waldur: GET /api/openstack-flavors/?name_exact=small&tenant_uuid=tenant-A-uuid
    Waldur-->>Resolver: Returns the correct Flavor object for Tenant A.
    Resolver-->>Runner: Returns Flavor URL

    Note over Runner, Waldur: Runner now has all resolved URLs and creates the final marketplace order.

Resolving Lists of Items

Another common scenario is a parameter that accepts a list of resolvable items, such as the security_groups for a VM.

  • The Problem: The user wants to provide a simple list of names: security_groups: ['web', 'ssh']. The API, however, often requires a more complex structure, like a list of objects: security_groups: [{ "url": "https://.../sg-web-uuid/" }, { "url": "https://.../sg-ssh-uuid/" }].

  • The Solution: The resolver system handles this automatically. The generator analyzes the OpenAPI schema for the offering_type. When it sees that the security_groups attribute is an array of objects with a url property, it configures the runner to:

    1. Iterate through the user's simple list (['web', 'ssh']).
    2. Resolve each name individually to its full object, using the security_groups resolver configuration (which itself uses dependency filtering, as shown above).
    3. Extract the url from each resolved object.
    4. Construct the final list of dictionaries in the format required by the API.

This powerful abstraction keeps the Ansible playbook clean and simple, hiding the complexity of the underlying API. The user only needs to provide the list of names, and the resolver handles the rest.

The Unified Update Architecture

The generator employs a sophisticated, unified architecture for handling resource updates within state: present tasks. This system is designed to be both powerful and consistent, ensuring that all generated modules—regardless of their plugin (crud or order)—behave predictably and correctly, especially when dealing with complex data structures.

The core design principle is "Specialized Setup, Generic Execution." Specialized runners (CrudRunner, OrderRunner) are responsible for preparing a context-specific environment, while a shared BaseRunner provides a powerful, generic toolkit of "engine" methods that perform the actual update logic. This maximizes code reuse and enforces consistent behavior.

Core Components

  1. BaseRunner (The Engine): This class contains the three central methods that form the update toolkit:

    • _handle_simple_updates(): Manages direct PATCH requests for simple, mutable fields (like name or description).
    • _handle_action_updates(): Orchestrates the entire lifecycle for complex, action-based updates (like setting security group rules).
    • _normalize_for_comparison(): A critical utility that provides robust, order-insensitive idempotency checks for complex data types like lists of dictionaries.

  2. Specialized Runners (The Orchestrators):

    • CrudRunner: Uses the BaseRunner toolkit directly with minimal setup, as its context is typically straightforward.
    • OrderRunner: Performs crucial, context-specific setup (like priming its cache with the marketplace offering) before delegating to the same BaseRunner toolkit.

Deep Dive: The Idempotency Engine (_normalize_for_comparison)

The cornerstone of the update architecture is its ability to correctly determine if a change is needed, especially for lists of objects where order does not matter. The _normalize_for_comparison method is the "engine" that makes this possible.

Problem: How do you compare [{'subnet': 'A'}] from a user's playbook with [{'uuid': '...', 'subnet': 'A', 'name': '...'}] from the API? How do you compare ['A', 'B'] with ['B', 'A']?

Solution: The method transforms both the desired state and the current state into a canonical, order-insensitive, and comparable format (a set) before checking for equality.

Mode A: Complex Objects (e.g., a list of ports)

When comparing lists of dictionaries, the method uses idempotency_keys (provided by the generator plugin based on the API schema) to understand what defines an object's identity.

  1. Input (Desired State): [{'subnet': 'url_A', 'fixed_ips': ['1.1.1.1']}]
  2. Input (Current State): [{'uuid': 'p1', 'subnet': 'url_A', 'fixed_ips': ['1.1.1.1']}]
  3. Idempotency Keys: ['subnet', 'fixed_ips']
  4. Process:
    • For each dictionary, it creates a new one containing only the idempotency_keys.
    • It converts this filtered dictionary into a sorted, compact JSON string (e.g., '{"fixed_ips":["1.1.1.1"],"subnet":"url_A"}'). This string is deterministic and hashable.
    • It adds these strings to a set.
  5. Result: Both inputs are transformed into the exact same set: {'{"fixed_ips":["1.1.1.1"],"subnet":"url_A"}'}. The comparison set1 == set2 evaluates to True, and no change is triggered. Idempotency is achieved.

Mode B: Simple Values (e.g., a list of security_group URLs)

When comparing lists of simple values (strings, numbers), the solution is simpler.

  1. Input (Desired State): ['url_A', 'url_B']
  2. Input (Current State): ['url_B', 'url_A']
  3. Process: It converts both lists directly into sets.
  4. Result: Both inputs become {'url_A', 'url_B'}. The comparison set1 == set2 is True, and no change is triggered.

Handling Critical Edge Cases

The unified architecture is designed to handle two critical, real-world edge cases that often break simpler update logic.

Edge Case 1: Asymmetric Data Representation

  • Problem: An existing resource might represent a relationship with a "rich" list of objects (e.g., security_groups: [{'name': 'sg1', 'url': '...'}]), but the API action to update them requires a "simple" list of strings (e.g., ['url1', 'url2']).
  • Solution: The _handle_action_updates method contains specific logic to detect this asymmetry. If the resolved user payload is a simple list of strings, but the resource's current value is a complex list of objects, it intelligently transforms the resource's list by extracting the url from each object before passing both simple lists to the normalizer. This ensures a correct, apples-to-apples comparison.

Edge Case 2: Varied API Payload Formats

  • Problem: Some API action endpoints expect a JSON object as the request body (e.g., {"rules": [...]}), while others expect a raw JSON array (e.g., [...]).
  • Solution: The generator plugin analyzes the OpenAPI specification for each action endpoint. It passes a boolean flag, wrap_in_object, in the runner's context. The _handle_action_updates method reads this flag and constructs the final_api_payload in the precise format the API endpoint requires, avoiding schema validation errors.

This robust, flexible, and consistent architecture ensures that all generated modules are truly idempotent and can handle the full spectrum of simple and complex update scenarios presented by the Waldur API.

Component Responsibilities

  1. Core System (generator.py, plugin_manager.py):

    • Generator: The main orchestrator. It is type-agnostic. Its job is to:
      1. Loop through each collection definition in the config.
      2. For each collection, create the standard directory skeleton (galaxy.yml, etc.).
      3. Loop through the module definitions within that collection.
      4. Delegate to the correct plugin to get a GenerationContext.
      5. Render the final module file.
      6. Copy the plugin's runner.py and a shared base_runner.py into module_utils, rewriting their imports to make the collection self-contained.
    • PluginManager: The discovery service. It finds and loads all available plugins registered via entry points.

  2. Plugin Interface (interfaces/plugin.py):

    • BasePlugin: An abstract base class defining the contract for all plugins. It requires a generate() method that receives the module configuration, API parsers, and the current collection context (namespace/name) and returns a complete GenerationContext.

  3. Runtime Components (interfaces/runner.py, interfaces/resolver.py):

    • BaseRunner: A concrete base class that provides shared runtime utilities for all runners, such as the send_request helper for making API calls.
    • ParameterResolver: A reusable class that encapsulates all logic for converting user inputs (names/UUIDs) into API-ready data. It is instantiated by runners.

  4. Concrete Plugins and Runners (e.g., plugins/crud/):

    • Each plugin is a self-contained directory with:
      • config.py: Pydantic models for validating its specific YAML configuration.
      • plugin.py: The generation-time logic. It implements BasePlugin and is responsible for creating the module's documentation, parameters, and runner context.
      • runner.py: The runtime logic. It inherits from BaseRunner, uses the ParameterResolver, and executes the module's core state management tasks (e.g., creating a resource if it doesn't exist).

How to Add a New Plugin

This architecture makes adding support for a new module type straightforward:

  1. Create Plugin Directory: Create a new directory for your plugin, e.g., ansible_waldur_generator/plugins/my_type/.

  2. Define Configuration Model: Create plugins/my_type/config.py with a Pydantic model inheriting from BaseModel to define and validate the YAML structure for your new type.

  3. Implement the Runner: Create plugins/my_type/runner.py. Define a class (e.g., MyTypeRunner) that inherits from BaseRunner and implements the runtime logic for your module.

  4. Implement the Plugin Class: Create plugins/my_type/plugin.py: 

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    from ansible_waldur_generator.interfaces.plugin import BasePlugin
from ansible_waldur_generator.models import GenerationContext
# Import your config model and other necessary components

class MyTypePlugin(BasePlugin):
    def get_type_name(self) -> str:
        # This must match the 'type' key in the YAML config
        return 'my_type'

    def generate(self, module_key, raw_config, api_parser, ...) -> GenerationContext:
        # 1. Parse and validate raw_config using your Pydantic model.
        # 2. Use api_parser to get details about API operations.
        # 3. Build the argument_spec, documentation, examples, etc.
        # 4. Build the runner_context dictionary to pass runtime info to your runner.
        # 5. Return a fully populated GenerationContext object.
        return GenerationContext(...)

  5. Register the Plugin: Add the new plugin to the entry points section in pyproject.toml: 

    1
2
3
4
5
6
    [tool.poetry.plugins."ansible_waldur_generator"]
# ... existing plugins
crud = "ansible_waldur_generator.plugins.crud.plugin:CrudPlugin"
order = "ansible_waldur_generator.plugins.order.plugin:OrderPlugin"
facts = "ansible_waldur_generator.plugins.facts.plugin:FactsPlugin"
my_type = "ansible_waldur_generator.plugins.my_type.plugin:MyTypePlugin" # Add this line

  6. Update Poetry Environment: Run poetry install. This makes the new entry point available to the PluginManager. Your new my_type is now ready to be used in generator_config.yaml.

After these steps, running poetry install will make the new facts type instantly available to the generator without any changes to the core generator.py or plugin_manager.py files.

How to Use the Generated Collection

Once generated, the collection can be used immediately for local testing or packaged for distribution. End-users who are not developing the generator can skip directly to the "Installing from Ansible Galaxy" section.

Method 1: Local Development and Testing

The most straightforward way to test is to tell Ansible where to find your newly generated collection by setting an environment variable.

  1. Set the Collection Path: From the root of your project, run: 

    1
    export ANSIBLE_COLLECTIONS_PATH=./outputs
    This command tells Ansible to look for collections inside the outputs directory. This setting lasts for your current terminal session.

  2. Run an Ad-Hoc Command: You can now test any module using its Fully Qualified Collection Name (FQCN). This is perfect for a quick check.

    Command: 

    1
2
3
4
5
6
7
    # Test the 'waldur.structure.project' module from the 'waldur.structure' collection
ansible localhost -m waldur.structure.project \
  -a "state=present \
      name='My AdHoc Project' \
      customer='Big Corp' \
      api_url='https://api.example.com/api/' \
      access_token='YOUR_SECRET_TOKEN'"

    Example Output (Success, resource created): 

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    localhost | CHANGED => {
    "changed": true,
    "commands": [
        {
            "body": {
                "customer": "https://api.example.com/api/customers/...",
                "name": "My AdHoc Project"
            },
            "description": "Create new project",
            "method": "POST",
            "url": "https://api.example.com/api/projects/"
        }
    ],
    "resource": {
        "created": "2024-03-21T12:00:00.000000Z",
        "customer": "https://api.example.com/api/customers/...",
        "customer_name": "Big Corp",
        "description": "",
        "name": "My AdHoc Project",
        "url": "https://api.example.com/api/projects/...",
        "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

    Example Output (Success, resource already existed): 

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    localhost | SUCCESS => {
    "changed": false,
    "commands": [],
    "resource": {
        "created": "2024-03-21T12:00:00.000000Z",
        "customer": "https://api.example.com/api/customers/...",
        "customer_name": "Big Corp",
        "description": "",
        "name": "My AdHoc Project",
        "url": "https://api.example.com/api/projects/...",
        "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

    Security Warning: Passing access_token on the command line is insecure. For production, use Ansible Vault or environment variables as shown in the playbook method.

  3. Use in a Playbook: This is the standard and recommended way to use the collection for automation.

    test_playbook.yml: 

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    - name: Manage Waldur Resources with Generated Collection
  hosts: localhost
  connection: local
  gather_facts: false
  # Good practice to declare the collection you are using
  collections:
    - waldur.structure

  vars:
    waldur_api_url: "https://api.example.com/api/"
    waldur_access_token: "WALDUR_ACCESS_TOKEN"

  tasks:
    - name: Ensure 'My Playbook Project' exists
      # Use the FQCN of the module
      project:
        state: present
        name: "My Playbook Project"
        customer: "Big Corp"
        api_url: "{{ waldur_api_url }}"
        access_token: "{{ waldur_access_token }}"
      register: project_info

    - name: Show the created or found project details
      ansible.builtin.debug:
        var: project_info.resource

    Run the playbook: 

    1
2
3
4
5
6
    # Set the environment variables first
export ANSIBLE_COLLECTIONS_PATH=./outputs
export WALDUR_ACCESS_TOKEN='YOUR_SECRET_TOKEN'

# Run the playbook
ansible-playbook test_playbook.yml

Example Output (Success, resource created): 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
PLAY [Manage Waldur Resources with Generated Collection] ******************

TASK [Ensure 'My Playbook Project' exists] **************************************
changed: [localhost]

TASK [Show the created or found project details] ********************************
ok: [localhost] => {
    "project_info": {
        "changed": true,
        "commands": [
            {
                "body": {
                    "customer": "https://api.example.com/api/customers/...",
                    "name": "My Playbook Project"
                },
                "description": "Create new project",
                "method": "POST",
                "url": "https://api.example.com/api/projects/"
            }
        ],
        "failed": false,
        "resource": {
            "created": "2024-03-21T12:05:00.000000Z",
            "customer": "https://api.example.com/api/customers/...",
            "customer_name": "Big Corp",
            "description": "",
            "name": "My Playbook Project",
            "url": "https://api.example.com/api/projects/...",
            "uuid": "a1b2c3d4e5f67890abcdef1234567890"
        }
    }
}

PLAY RECAP **********************************************************************
localhost                  : ok=2    changed=1    unreachable=0    failed=0    ...

Publishing and Installing

Publishing to Ansible Galaxy

The generated output is ready to be published, making your modules available to everyone.

  1. Build the Collection Archive: Navigate to the root of the generated collection and run the build command. The output tarball will be placed in the parent directory. 

    1
2
3
4
5
    # Navigate to the actual collection directory
cd outputs/ansible_collections/waldur/structure/

# Build the collection, placing the output tarball in the `outputs` directory
ansible-galaxy collection build --output-path ../../../..
    This will create a file like outputs/waldur-structure-1.0.0.tar.gz.

  2. Get a Galaxy API Key:

    • Log in to galaxy.ansible.com.
    • Navigate to Namespaces and select your namespace.
    • Copy your API key from the "API Key" section.

  3. Publish the Collection: Use the ansible-galaxy command to upload your built archive. 

    1
2
3
4
5
6
    # Set the token as an environment variable (note the correct variable name)
export ANSIBLE_GALAXY_TOKEN="your_copied_api_key"

# From the `outputs` directory, publish the tarball
cd outputs/
ansible-galaxy collection publish waldur-structure-1.0.0.tar.gz

Installing from Ansible Galaxy (for End-Users)

Once the collection is published, any Ansible user can easily install and use it.

  1. Install the Collection: 

    1
    ansible-galaxy collection install waldur.structure

  2. Use it in a Playbook: After installation, the modules are available globally. Users can simply write playbooks referencing the FQCN.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
    - name: Create a Waldur Project
  hosts: my_control_node
  tasks:
    - name: Ensure project exists
      waldur.structure.project:
        state: present
        name: "Production Project"
        customer: "Customer Name"
        api_url: "https://api.waldur.com/api/"
        access_token: "{{ my_waldur_token }}"

End-to-End Testing with VCR

This project uses a powerful "record and replay" testing strategy for its end-to-end (E2E) tests, powered by pytest and the VCR.py library. This allows us to create high-fidelity tests based on real API interactions while ensuring our CI/CD pipeline remains fast, reliable, and completely independent of a live API server.

The E2E tests are located in the tests/e2e/ directory.

Core Concept: Cassette-Based Testing

  1. Recording Mode: The first time a test is run, it requires access to a live Waldur API. The test executes its workflow (e.g., creating a VM), and VCR.py records every single HTTP request and its corresponding response into a YAML file called a "cassette" (e.g., tests/e2e/cassettes/test_create_instance.yaml).

  2. Replaying Mode: Once a cassette file exists, all subsequent runs of the same test will be completely offline. VCR.py intercepts any outgoing HTTP call, finds the matching request in the cassette, and "replays" the saved response. The test runs instantly without any network activity.

This approach gives us the best of both worlds: the realism of integration testing and the speed and reliability of unit testing.

Running the E2E Tests

The E2E tests are designed to be run in two distinct modes.

Mode 1: Replaying (Standard CI/CD and Local Testing)

This is the default mode. If the cassette files exist in tests/e2e/cassettes/, the tests will run offline. This is the fastest and most common way to run the tests.

1
2
# Run all E2E tests using their saved cassettes
poetry run pytest tests/e2e/

This command should complete in a few seconds.

Mode 2: Recording (When Adding or Modifying Tests)

You only need to enter recording mode when you are: * Creating a new E2E test. * Modifying an existing E2E test in a way that changes its API interactions (e.g., adding a new parameter to a module call).

Workflow for Recording a Test:

  1. Prepare the Live Environment: Ensure you have a live Waldur instance and that all the necessary prerequisite resources for your test exist (e.g., for creating a VM, you need a project, offering, flavor, image, etc.).

  2. Set Environment Variables: Provide the test runner with the credentials for the live API. Never hardcode these in the test files.

    1
2
    export WALDUR_API_URL="https://your-waldur-instance.com/api/"
export WALDUR_ACCESS_TOKEN="<your_real_api_token>"

  3. Delete the Old Cassette: To ensure a clean recording, delete the corresponding YAML file for the test you are re-recording. pytest-vcr names cassettes based on the test file and function name.

    1
2
    # Example for the instance creation test
rm tests/e2e/cassettes/test_e2e_modules.py::TestInstanceModule::test_create_instance.yaml

  4. Run Pytest: Execute the test. It will now connect to the live API specified by your environment variables.

    1
2
    # Run a specific test to record its interactions
poetry run pytest tests/e2e/test_e2e_modules.py::TestInstanceModule::test_create_instance

    After the test passes, a new cassette file will be generated.

  5. Review and Commit:

    • CRITICAL: Inspect the newly generated .yaml cassette file.
    • Verify that sensitive data, like the Authorization token, has been automatically scrubbed and replaced with a placeholder (e.g., DUMMY_TOKEN). This is configured in pyproject.toml or pytest.ini.
    • Commit the new or updated cassette file to your Git repository along with your test code changes.

Writing a New E2E Test

Follow the pattern established in tests/e2e/test_e2e_modules.py:

  1. Organize with Classes: Group tests for a specific module into a class (e.g., TestVolumeModule).
  2. Use the @pytest.mark.vcr Decorator: Add this decorator to your test class or individual test methods to enable VCR.
  3. Use the auth_params Fixture: This fixture provides the standard api_url and access_token parameters, reading them from environment variables during recording and using placeholders during replay.
  4. Use the run_module_harness: This generic helper function handles the boilerplate of mocking AnsibleModule and running the module's main() function.
  5. Write Your Test Logic:
    • Arrange: Define the user_params dictionary that simulates the Ansible playbook input.
    • Act: Call the run_module_harness, passing it the imported module object and the user_params.
    • Assert: Check the exit_result and fail_result to verify that the module behaved as expected (e.g., changed is True, the returned resource has the correct data).

Example Skeleton: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# In a test file within tests/e2e/

import pytest
from ansible_collections.waldur.structure.plugins.modules import project as project_module
# ... import harness and fixtures ...

@pytest.mark.vcr
class TestProjectModule:
    def test_create_new_project(self, auth_params):
        # 1. Arrange: Define user input
        user_params = {
            "state": "present",
            "name": "E2E New Project",
            "customer": "Big Corp",
            **auth_params
        }

        # 2. Act: Run the module
        exit_result, fail_result = run_module_harness(project_module, user_params)

        # 3. Assert: Verify the outcome
        assert fail_result is None
        assert exit_result['changed'] is True
        assert exit_result['resource']['name'] == "E2E New Project"

Waldur Release Lifecycle and API Stability Guarantees

Introduction to API Policies

Waldur's API lifecycle management balances innovation with stability through defined policies:

  • Release Cadence:
  • 2 major releases per year (every 6 months)

  • 4 minor releases per year (every 3 months)

  • API Group Segmentation:

  • APIs are grouped by functional domains (e.g., core, marketplace, openstack)

  • Groups have independent maturity levels and versioning

  • API Maturity Management:

  • Three maturity levels: alpha, beta, stable

  • Each level has specific stability guarantees and versioning rules

  • Change Classification:

  • Backward-compatible (additive changes) and backward-incompatible (breaking changes)

  • API changes, database changes, configuration and deployment changes

  • Change Communication:

  • For Waldur developers: via commit message and OpenAPI schema linter
  • For release manager: breaking changes in stable APIs trigger policy validation
  • For external developers: via OpenAPI schema, SDK documentation, code transformations and validation tools
  • For external scripts: via OpenAPI schema validation and version validation in HTTP response
  • For Waldur operators: via release impact assesment CLI tooling and Waldur dashboard

Waldur MasterMind lifecycle strategy enables:

  • Rapid Innovation through alpha/beta channels
  • Enterprise Stability through backported security patches
  • Risk Mitigation with pre-upgrade analysis
  • Seamless Upgrades using migration tooling

Release Cadence

Waldur MasterMind Release Timeline

gantt
    dateFormat  YYYY-MM-DD
    axisFormat  %b %Y

    section Releases
    Major 2025.1 : milestone, m1, 2025-01-01, 0d
    Minor 2025.1.1 : milestone, m2, 2025-04-01, 0d
    Minor 2025.1.2 : milestone, m3, 2025-07-01, 0d
    Minor 2025.1.3 : milestone, m4, 2025-10-01, 0d

    section Stable API v1
    Active Support : active_stable1, 2025-01-01, 2025-07-01
    Security Maintenance : maint_stable1, 2025-07-01, 2026-01-01

    section Stable API v2
    Active Support : active_stable2, 2025-07-01, 2026-01-01

    section Beta API v1beta1
    Active Support : active_beta1, 2025-01-01, 2025-04-01
    Maintenance : maint_beta1, 2025-04-01, 2025-07-01

    section Beta API v1beta2
    Active Support : active_beta2, 2025-04-01, 2025-07-01

    section Alpha API v1alpha1
    Unsupported : alpha1, 2025-01-01, 2025-04-01

    section Alpha API v1alpha2
    Unsupported : alpha2, 2025-04-01, 2025-07-01

API Maturity Levels

Maturity Breaking Changes Support Window Version Format Recommended Use
Alpha Daily None 2025.2-dev.45 Internal development only
Beta Quarterly 90 days 2025.2-beta.3 Preview environments
Stable Bi-annually 180 days 2025.2.5 General production

Alpha Level

  • Versioning: XalphaY (e.g., 1alpha1)
  • Availability: In main repo, disabled by default (feature flag)
  • Audience: Developers and expert users
  • Completeness: Partial implementation expected
  • Upgradeability: No upgrade path; breaking changes without notice
  • Reliability: May destabilize deployments
  • Support: No commitment to completion or long-term support
  • Use Cases: Short-lived testing environments only

Beta Level

  • Versioning: XbetaY (e.g., 2beta3)
  • Availability: In releases, disabled by default (feature flag)
  • Audience: Users providing feedback
  • Completeness: Full implementation with API review
  • Upgradeability: Breaking changes with documented migration path
  • Reliability: Minor bugs possible, shouldn't break core functionality
  • Support: Two concurrent versions supported for ≥1 minor release (3 months)
  • Use Cases: Evaluation environments and limited production trials

Stable Level

  • Versioning: X (e.g., v3)
  • Availability: Enabled by default in releases
  • Audience: All users
  • Completeness: Full implementation with integration tests
  • Upgradeability: Only backward-compatible changes allowed
  • Reliability: High stability guarantee
  • Support: Maintained for ≥1 major release cycle (6 months) after deprecation
  • Use Cases: All production environments

Types of API Changes

Backward-Incompatible Changes

  • URL format changes
  • Removing/renaming resources, parameters, properties, or methods
  • Changing parameter/property types
  • Modifying HTTP status codes
  • Changing optional field to mandatory in REST API
  • Adding required parameters

Backward-Compatible Changes

  • Adding new resources
  • Adding operations to existing resources
  • Adding optional parameters
  • Adding response fields
  • Extending string formats
  • Adding enum values
graph TD
    A[Proposed API Change] --> B{Backward Compatible?}
    B -->|Yes| C[Apply to current version]
    B -->|No| D{Maturity Level}
    D -->|Alpha| E[Increment alpha version<br>e.g. v1alpha1 → v1alpha2]
    D -->|Beta| F[Increment beta version<br>e.g. v1beta1 → v1beta2<br>Support both for ≥3 months]
    D -->|Stable| G[Create new major version<br>e.g. v1 → v2<br>Deprecate old version<br>Support for ≥6 months]

Change Communication

Change Communication Stages

flowchart LR
    %% Merged Development & Pre-Release Phase
    subgraph DevPre[Development & Pre-Release]
        direction TB
        DP1[Commit Messages]
        DP2[OpenAPI Linter]
        DP3[Policy Validation]
        DP4[Breaking Change Review]
        DP1 --> DP2 --> DP3 --> DP4
    end

    subgraph Release[Release Phase]
        direction TB
        R1[OpenAPI Schema]
        R2[SDK Docs]
        R3[Code Tools]
        R1 --> R2 --> R3
    end

    subgraph Runtime[Runtime Phase]
        direction TB
        RT1[HTTP Headers]
        RT2[Schema Validation]
        RT1 --> RT2
    end

    subgraph Upgrade[Upgrade Phase]
        direction TB
        U1[Impact CLI]
        U2[Dashboard]
        U3[Dry-Run]
        U1 --> U2 --> U3
    end

    %% Connections between phases
    DevPre --> Release
    Release --> Runtime
    Runtime --> Upgrade

Change Communication Schedule

gantt
    title Deprecation Schedule for API v2025.1
    dateFormat  YYYY-MM-DD
    section Lifecycle
    Active Development : active, 2025-01-01, 90d
    Deprecation Notice : 2025-04-01, 90d
    Compatibility Mode : 2025-07-01, 90d
    End of Life        : 2025-10-01, 1d
Phase Duration Communication Channels
Announcement 90 days API headers, OpenAPI metadata, email notices, developer portal
Compatibility 180 days Support both versions, code transformation tools, migration guides
End of Life Immediate Remove deprecated endpoints

Impact Preview & Reporting

graph LR
    A[Upgrade Initiated] --> B[Version Comparison]
    B --> C[Database Impact Scan]
    B --> D[Config Change Analysis]
    B --> E[API Compatibility Check]
    C --> F[Migration Preview Report]
    D --> G[Config Diff Report]
    E --> H[Breaking Changes List]
    F --> I[Consolidated Impact Report]
    G --> I
    H --> I

Impact Report Components

  • Database Impact:

  • Schema changes

  • Data migration requirements

  • Estimated execution time

  • API Compatibility:

  • Breaking changes

  • Required client updates

  • Deprecation timeline

  • Configuration Changes:

  • Modified settings

  • New environment variables
  • Security implications

Impact Report Sample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "upgrade_path": "2025.1 → 2025.2",
  "risk_level": "medium",
  "estimated_downtime": "15 minutes",
  "critical_issues": [
    {
      "type": "schema_change",
      "location": "marketplace/Resources",
      "description": "Required field 'category' added"
    }
  ],
  "actions_required": [
    "Update client code to handle new required field",
    "Execute a management command to migrate data"
  ]
}

Stabilization Action Plan

Phase 1: Inventory & Classification

  • Catalog all API endpoints by functional group
  • Assign current maturity level (alpha/beta/stable)
  • Identify breaking changes in last 2 releases

Phase 2: Stabilization Foundations

  • Add header-based versioning (Waldur-Version)
  • Introduce version match validation in SDK
  • Introduce standardized error format
  • OpenAPI schema validation in pull requests
  • Breaking change detection gates
  • Automated SDK documentation publishing
  • Set up versioning automation for alpha/beta releases

Phase 3: Impact Analysis Tooling

  • Database migration previews
  • Configuration change detection
  • API compatibility scanning
  • Dry-run execution framework
  • Risk score calculation
  • Data loss probability assessment
  • Downtime estimation
  • Actionable remediation steps
  • Automated customer alerts
  • Personalized impact assessments
  • Upgrade scheduling dashboard

Key Metrics for Success

  • 100% breaking changes detected in CI
  • Zero unannounced breaking changes in stable APIs
  • 90%+ deprecated endpoints removed on schedule
  • <30 days between beta and stable promotion
  • 100% of new features launch behind feature flags

Example workflows

These examples demonstrate how to apply lifecycle and communication rules in practice.

Patching and Releasing an Older Supported Release

Context: Waldur 2025.1 is in Security Maintenance phase.

Scenario: A security bug is discovered in the marketplace app in version 2025.1.

Steps:

  1. Create a branch from the release/2025.1 tag.
  2. Apply the patch fix (e.g., sanitize input in marketplace.views.OfferingViewSet).
  3. Bump patch version: 2025.1.4 → 2025.1.5.
  4. Add changelog entry under SECURITY FIXES.
  5. Create new tag release/2025.1.5, trigger CI/CD.

Communication:

  • Email notification for operators
  • Waldur HomePort dashboard warning for operators

Adding a New Endpoint in a Mature App (e.g., openstack, maturity: stable)

Scenario: Add a new endpoint to list all flavors with extended metadata.

Constraints:

  • Must be backward-compatible
  • Cannot break existing consumers

Steps:

  1. Create a new action or viewset method: GET /openstacktenant-flavors/extended/.
  2. Use @extend_schema to document new response format in OpenAPI.
  3. Add unit and integration tests.
  4. Add a changelog entry under FEATURES.
  5. Merge into develop.
  6. New version number will be minor: e.g., 2025.2.3 → 2025.2.4.

Communication:

  • Added to OpenAPI schema
  • SDK is regenerated
  • Endpoint is announced in changelog

Adding a New Endpoint in an Experimental App (e.g., checklist, maturity: alpha)

Scenario: Introduce a new endpoint for scoring checklist responses.

Steps:

  1. Create endpoint: POST /checklist-items/{uuid}/score/.
  2. No guarantee of stability — endpoint can be renamed/removed later.
  3. Version updated in checklist.VERSION = 2025.2-alpha.7.
  4. No changelog required, but internal commit message must follow pattern:
1
feat(checklist): add scoring endpoint [alpha]

Communication:

  • Only available when feature flag enabled
  • Not included in stable OpenAPI documentation
  • Optional preview in dev dashboard

Reporting

Examples below show how it's possible to use Waldur SDK for generation of custom reports.

Running the scripts

All of the scripts below should be saved as files and executed in the environment with installed Waldur SDK. Please make sure that you have python3 and pip installed in your command line.

Make sure that you update WALDUR_HOST and TOKEN with values that match your target Waldur deployment.

1
2
pip install https://github.com/waldur/python-waldur-client/archive/master.zip
python <reporting-script-name>.py

Project reporting

The first scenario is report generation about monthly costs of each project. The name of the output file is project-report.csv.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
import os
import csv
from collections import defaultdict
from datetime import datetime
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_list
from waldur_api_client.api.invoice_items import invoice_items_list

# Constants
CURRENT_YEAR = datetime.now().year
CURRENT_MONTH = datetime.now().month
CSV_FILE_PATH = 'project-report.csv'
HEADER = [
    'Organization name',
    'Organization abbreviation',
    'Project name',
    'Monthly cost of a project',
]

# Initialize client
client = AuthenticatedClient(
    base_url=os.environ.get('WALDUR_API_URL'),
    token=os.environ.get('WALDUR_API_TOKEN'),
)

# Get all customers
customers = customers_list.sync(client=client)
if not customers:
    print("No customers found")
    exit()

with open(CSV_FILE_PATH, 'w', encoding='UTF8') as out_file:
    writer = csv.writer(out_file)
    writer.writerow(HEADER)

    for customer in customers:
        project_reporting = defaultdict(lambda: 0.0)

        # Get invoice items for the customer
        items = invoice_items_list.sync(
            client=client,
            customer_uuid=customer.uuid,
            year=CURRENT_YEAR,
            month=CURRENT_MONTH
        )

        if items:
            for item in items:
                if item.name and item.unit_price:
                    project_reporting[item.name] += float(item.unit_price)
            # Write to CSV file
            for project_name, cost in project_reporting.items():
                writer.writerow([
                    customer.name,
                    customer.abbreviation,
                    project_name,
                    cost,
                ])

Example of output file content:

1
2
3
4
5
Organization name,Organization abbreviation,Project name,Monthly cost of a project
Org A,OA,Team1,10
Org B,OB,Demo project,70
Org B,OB,Industrial project,100
Org C,OC,Lab1,110

OpenStack tenant reporting

The second scenario is report generation about quotas and monthly costs of OpenStack tenants.

The name of the output file is openstack-report.csv.

Code example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
import os
import csv
from datetime import datetime
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_list
from waldur_api_client.api.invoice_items import invoice_items_list
from waldur_api_client.api.marketplace_resources import marketplace_resources_list
from waldur_api_client.api.openstack_tenants import openstack_tenants_list

# Constants
CURRENT_YEAR = datetime.now().year
CURRENT_MONTH = datetime.now().month
CSV_FILE_PATH = 'openstack-report.csv'
HEADER = [
    'Name of the OpenStack Tenant resource',
    'vCPU limit',
    'RAM limit',
    'Storage limit',
    'Monthly cost of the resource',
    'Project name',
    'Organization name',
    'Organization abbreviation',
]

# Initialize client
client = AuthenticatedClient(
    base_url=os.environ.get('WALDUR_API_URL'),
    token=os.environ.get('WALDUR_API_TOKEN'),
)

# Get all customers
customers = customers_list.sync(client=client)
if not customers:
    print("No customers found")
    exit()

with open(CSV_FILE_PATH, 'w', encoding='UTF8') as out_file:
    writer = csv.writer(out_file)
    writer.writerow(HEADER)

    for customer in customers:
        # Get invoice items for the customer
        items = invoice_items_list.sync(
            client=client,
            customer_uuid=customer.uuid,
            year=CURRENT_YEAR,
            month=CURRENT_MONTH
        )

        # Create resource costs mapping
        resource_costs = {}
        for item in items:
            if item.name and item.unit_price:
                resource_costs[item.name] = float(item.unit_price)


        # Get tenants for the customer
        tenants = openstack_tenants_list.sync(
            client=client,
            customer_uuid=customer.uuid
        )

        for tenant in tenants:
            if not tenant.marketplace_resource_uuid:
                continue

            # Get resource details
            resources = marketplace_resources_list.sync(
                client=client,
                uuid=tenant.marketplace_resource_uuid
            )

            if not resources:
                continue

            resource = resources[0]
            limits = resource.limits or {}

            writer.writerow([
                tenant.name,
                limits.get('cores', 0),
                limits.get('ram', 0),
                limits.get('storage', 0),
                resource_costs.get(str(tenant.marketplace_resource_uuid), 0.0),
                tenant.project_name,
                tenant.customer_name,
                tenant.customer_abbreviation
            ])

Example of output file content:

1
2
3
4
5
Name of the OpenStack.Tenant resource,vCPU limit,RAM limit,Storage limit,Monthly cost of the resource,Project name,Organization name,Organization abbreviation
HPC_resource,2.0,4096.0,61440.0,2.18,Team1,Org A,OA
OpenStack Cloud for testing,1,1024,102400,5.17,Demo project,Org B,OB
OpenStack Cloud,12,51200,614400,21.77,Industrial project,Org B,OB
Private Cloud,1,1024,102400,5.17,Lab1,Org C,OC

Reporting by provider

To get CSV summary of consumption by provider, the following script can be useful. Output will be a file per provider with a short summary of invoice items for the defined period.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
import csv
from collections import defaultdict
import unicodedata
import re
from decimal import Decimal
from datetime import datetime

from waldur_api_client import AuthenticatedClient
from waldur_api_client.api.customers import customers_list
from waldur_api_client.api.invoices import invoices_list
from waldur_api_client.errors import UnexpectedStatus

# Your Waldur instance data
WALDUR_HOST = 'example.waldur.com'
TOKEN = 'SUPPORT_STAFF_SECRET_TOKEN'

# Date-related constants
CURRENT_YEAR = datetime.now().year
CURRENT_MONTH = datetime.now().month


def slugify(value, allow_unicode=False):
    """
    Taken from https://github.com/django/django/blob/master/django/utils/text.py
    Convert to ASCII if 'allow_unicode' is False. Convert spaces or repeated
    dashes to single dashes. Remove characters that aren't alphanumerics,
    underscores, or hyphens. Convert to lowercase. Also strip leading and
    trailing whitespace, dashes, and underscores.
    """
    value = str(value)
    if allow_unicode:
        value = unicodedata.normalize('NFKC', value)
    else:
        value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore').decode('ascii')
    value = re.sub(r'[^\w\s-]', '', value.lower())
    return re.sub(r'[-\s]+', '-', value).strip('-_')

# Client instance initialization
client = AuthenticatedClient(
    base_url=WALDUR_HOST,
    token=TOKEN,
)

# Organizations data fetching
customers = customers_list.sync(client=client)

sp = {}

for customer in customers:
    try:
        # Invoices data fetching
        invoices = invoices_list.sync(
            client=client,
            customer_uuid=customer.uuid,
            year=CURRENT_YEAR,
            month=CURRENT_MONTH
        )
        if not invoices:
            continue
        invoice = invoices[0]
    # If customer doesn't have any projects or created after the requested month
    except UnexpectedStatus:
        continue

    for item in invoice.items:
        # allocate to SP
        if hasattr(item.details, 'service_provider_name'):
            provider_name = item.details.service_provider_name
            if provider_name in sp:
                sp[provider_name].append((item, customer.name))
            else:
                sp[provider_name] = [(item, customer.name)]

for provider in sp.keys():
    filename = f'{slugify(provider)}_{CURRENT_YEAR}_{CURRENT_MONTH}.csv'
    print('Generating', filename)
    with open(filename, 'w', encoding='UTF8') as out_file:
        writer = csv.writer(out_file)
        HEADER = [
            'Kood',
            'Nimetus',
            'Klient',
            'Kogus',
            'Hind',
            'Summa',
        ]
        writer.writerow(HEADER)
        for inv, customer_name in sp[provider]:
            code = inv.article_code
            try:
                code = inv.article_code.split('_')[0]
            except:
                # failed to parse custom logic
                pass
            writer.writerow(
                [
                    code,
                    inv.name,
                    customer_name,
                    int(Decimal(str(inv.quantity))),
                    inv.unit_price,
                    inv.price,
                ]
            )

Waldur Python SDK

Waldur SDK is a thin Python wrapper for common REST operations. It allows you to interact with the Waldur REST API directly from your Python code. The SDK is provided as a Python module named waldur_api_client.

Installation

The Waldur SDK is available on PyPI and can be installed using either pip or poetry:

1
2
pip install waldur-api-client
poetry add waldur-api-client

In order to perform operations, a user needs to create an instance of AuthenticatedClient class:

1
2
3
4
5
6
from waldur_api_client import AuthenticatedClient

client = AuthenticatedClient(
    base_url="https://api.example.com",
    token="SuperSecretToken",
)

This instance provides interface for further interaction with Waldur and will be used across examples in related documentation.

Error handling

If the API call fails or returns an unexpected status code, it may raise UnexpectedStatus exception if the client is configured with raise_on_unexpected_status=True. This can be handled using a try...except block. The exception contains both the status code and the response content for debugging purposes.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.api.marketplace_resources import marketplace_resources_list
from waldur_api_client.errors import UnexpectedStatus
import pprint

try:
    result = marketplace_resources_list.sync(client=client)
except UnexpectedStatus as e:
    print(f"Status code: {e.status_code}")
    print("Response content:")
    pprint.pprint(e.content)

The UnexpectedStatus exception is raised when:

  • The API returns a status code that is not documented in the OpenAPI specification
  • The raise_on_unexpected_status client setting is enabled (default is disabled)

If you are running your commands against Waldur deployment with broken TLS certificates (e.g. in development), the trick below can be used to disable validation of certificates by SDK, beware that this is a security risk.

1
2
3
4
5
client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl=False,
)

Sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

1
2
3
4
5
client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

Air gapped installation

If your machine from where you run SDK is not connected to the public Internet, you can use the following method to transfer required libraries.

On the machine with access to the Internet:

1
2
3
echo "https://github.com/waldur/py-client/archive/master.zip" > requirements.txt
mkdir dependencies
pip3 download -r requirements.txt -d dependencies/

Now transfer content of the dependencies folder and requirements.txt to a machine without public Internet and run.

1
pip3 install --no-index --find-links dependencies/  -r requirements.txt

Service Provider Onboarding

This page describes onboarding steps for a service provider via Waldur REST API.

Slurm Agent Integration

The following steps are specific for SLURM plugin in Waldur.

Creation of SLURM Offering in Waldur

This section describes creation of SLURM offering in Waldur, which is managed by Waldur Site Agent.

Example request

1
2
3
POST https://test-portal.example.com/api/marketplace-provider-offerings/
Authorization: Token <Org Owner Token>
Content-Type: application/json

Body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
    "name": "Test Cluster",
    "description": "Test Cluster",
    "customer": "https://test-portal.example.com/api/customers/354c1f993eb54228b336046417ffaf39/",
    "category": "https://test-portal.example.com/api/marketplace-categories/4588ff519260461893ab371b8fe83363/",
    "components": [
        {
            "type": "node_hours",
            "name": "Node hours",
            "measured_unit": "Node-hours",
            "billing_type": "usage",
            "limit_period": null
        }
    ],
    "plans": [
        {
            "name": "Default",
            "description": "Default plan",
            "unit": "month"
        }
    ],
    "type": "Marketplace.Slurm",
    "shared": true
}

Example response

Status code: 201

Body:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
{
    "url": "https://test-portal.example.com/api/marketplace-provider-offerings/b52a120a0301434a84571bde0b2b74bf/",
    "uuid": "b52a120a0301434a84571bde0b2b74bf",
    "created": "2025-02-04T08:37:14.715810Z",
    "name": "Test Cluster",
    "slug": "test-clu-1",
    "description": "Test Cluster",
    "full_description": "",
    "terms_of_service": "",
    "terms_of_service_link": "",
    "privacy_policy_link": "",
    "access_url": "",
    "endpoints": [],
    "roles": [],
    "customer": "https://test-portal.example.com/api/customers/354c1f993eb54228b336046417ffaf39/",
    "customer_uuid": "354c1f993eb54228b336046417ffaf39",
    "customer_name": "Test Customer",
    "project": null,
    "category": "https://test-portal.example.com/api/marketplace-categories/4588ff519260461893ab371b8fe83363/",
    "category_uuid": "4588ff519260461893ab371b8fe83363",
    "category_title": "HPC",
    "attributes": {},
    "options": {
        "order": [],
        "options": {}
    },
    "resource_options": {
        "options": {},
        "order": []
    },
    "components": [
        {
            "uuid": "30f86ef120a341dba1b7225cf891c77b",
            "billing_type": "usage",
            "type": "node_hours",
            "name": "Node hours",
            "description": "",
            "measured_unit": "Node-hours",
            "unit_factor": 1,
            "limit_period": null,
            "limit_amount": null,
            "article_code": "",
            "max_value": null,
            "min_value": null,
            "max_available_limit": null,
            "is_boolean": false,
            "default_limit": null,
            "factor": null,
            "is_builtin": false
        }
    ],
    "plugin_options": {},
    "secret_options": {},
    "service_attributes": {},
    "state": "Draft",
    "state_code": 1,
    "native_name": "",
    "native_description": "",
    "vendor_details": "",
    "getting_started": "",
    "integration_guide": "",
    "thumbnail": null,
    "order_count": 0,
    "plans": [
        {
            "url": "https://test-portal.example.com/api/marketplace-plans/8ffd1813ba2449bc928546a1dd94bca9/",
            "uuid": "8ffd1813ba2449bc928546a1dd94bca9",
            "name": "Default",
            "description": "Default plan",
            "article_code": "",
            "max_amount": null,
            "archived": false,
            "is_active": true,
            "unit_price": "0.0000000000",
            "unit": "month",
            "init_price": 0,
            "switch_price": 0,
            "backend_id": "",
            "organization_groups": [],
            "prices": {
                "node_hours": 0.0
            },
            "future_prices": {
                "node_hours": null
            },
            "quotas": {
                "node_hours": 0
            },
            "resources_count": 0
        }
    ],
    "screenshots": [],
    "type": "Marketplace.Slurm",
    "shared": true,
    "billable": true,
    "scope": null,
    "files": [],
    "paused_reason": "",
    "datacite_doi": "",
    "citation_count": -1,
    "latitude": null,
    "longitude": null,
    "country": "",
    "backend_id": "",
    "organization_groups": [],
    "image": null,
    "backend_metadata": {}
}

Setting up integration options of the SLURM Offering

For automated management of the offering-related accounts in Waldur, the service provider should update the integration options for the offering.

Example request

1
2
3
POST https://test-portal.example.com/api/marketplace-provider-offerings/b52a120a0301434a84571bde0b2b74bf/update_integration/
Authorization: Token <Org Owner Token>
Content-Type: application/json

Body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    {
        "backend_id": "",
        "plugin_options": {
            "homedir_prefix": "/home/",
            "initial_uidnumber": 5000,
            "initial_usergroup_number": 6000,
            "username_anonymized_prefix": "waldur_",
            "username_generation_policy": "waldur_username",
            "initial_primarygroup_number": 5000,
            "account_name_generation_policy": "project_slug",
            "supports_pausing": true,
            "supports_downscaling": true,
            "service_provider_can_create_offering_user": true
        },
        "secret_options": {},
        "service_attributes": {},
    }

Example response

Status code: 200

Body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    {
        "plugin_options": {
            "homedir_prefix": "/home/",
            "initial_uidnumber": 5000,
            "initial_usergroup_number": 6000,
            "username_anonymized_prefix": "waldur_",
            "username_generation_policy": "waldur_username",
            "initial_primarygroup_number": 5000,
            "account_name_generation_policy": "project_slug",
            "supports_pausing": true,
            "supports_downscaling": true
        }
    }

Activation of the SLURM Offering

After creation, the offering is in Draft state meaning the service provider can edit it, but it is hidden from Wadlur marketplace. In order to publish it, the service provider should activate the offering the way described below.

Example request

1
2
3
POST https://test-portal.example.com/api/marketplace-provider-offerings/b52a120a0301434a84571bde0b2b74bf/activate/
Authorization: Token <Org Owner Token>
Content-Type: application/json

Note: This endpoint doesn't require any body.

After sending this request, the offering becomes activated, its state switched to Active and users of the marketplace can order resources.

Example response

Status code: 201

Body: empty

Creation of a service account user

For further management of the offering, Waldur Site Agent need a service account with access to the offering. This section describes how to create such a user.

Example request

1
2
3
POST https://test-portal.example.com/api/users/
Authorization: Token <Staff Token>
Content-Type: application/json

Body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "username": "test_27dd96e5bbc141b3a49f",
    "email": "test_27dd96e5bbc141b3a49f@example.com",
    "is_staff": false,
    "is_active": true,
    "is_support": false,
    "agree_with_policy": true,
    "first_name": "test",
    "last_name": "27dd96e5bbc141b3a49f"
}

Example response

Status: 201

Body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    "url": "https://test-portal.example.com/api/users/619d60a1c54f484885dfdf42c1dc5dbe/",
    "uuid": "619d60a1c54f484885dfdf42c1dc5dbe",
    "username": "test_27dd96e5bbc141b3a49f",
    "slug": "test_27d-1",
    "full_name": "test 27dd96e5bbc141b3a49f",
    "native_name": "",
    "job_title": "",
    "email": "test_27dd96e5bbc141b3a49f@example.com",
    "phone_number": "",
    "organization": "",
    "civil_number": null,
    "description": "",
    "is_staff": false,
    "is_active": true,
    "is_support": false,
    "registration_method": "default",
    "date_joined": "2025-02-05T13:43:18.365132Z",
    "agreement_date": null,
    "preferred_language": "",
    "permissions": [],
    "requested_email": null,
    "affiliations": [],
    "first_name": "test",
    "last_name": "27dd96e5bbc141b3a49f",
    "identity_provider_name": "Local DB",
    "identity_provider_label": "Local DB",
    "identity_provider_management_url": "",
    "identity_provider_fields": [],
    "image": null,
    "identity_source": ""
}

Assigning service provider permissions to the user

After user creation, you need to grant them permissions for offering management. Waldur uses OFFERING.MANAGER role for this.

Example request

1
2
3
POST https://test-portal.example.com/api/marketplace-provider-offerings/b52a120a0301434a84571bde0b2b74bf/add_user/
Authorization: Token <Service Provider Token>
Content-Type: application/json

Body:

1
2
3
4
{
    "role": "OFFERING.MANAGER",
    "user": "619d60a1c54f484885dfdf42c1dc5dbe"
}

Example response

Status code: 201

Body: empty

Service Account Token Retrieval

As a staff user, you can fetch any other user's token. For this, use token endpoint on a selected user.

Example request

1
2
GET https://test-portal.example.com/api/users/619d60a1c54f484885dfdf42c1dc5dbe/token/
Authorization: Token <Staff Token>

Example response

Status code: 200

Body:

1
2
3
4
5
6
7
8
9
{
    "created": "2025-02-06T12:09:46.296525Z",
    "token": "668bf4c77f81edcb2de181d72df40bf7b4e2a6c2",
    "user_first_name": "test",
    "user_is_active": true,
    "user_last_name": "27dd96e5bbc141b3a49f",
    "user_token_lifetime": "3600",
    "user_username": "test_27dd96e5bbc141b3a49f"
}

Service Account Token Refresh

As a staff user, you can also manually refresh any other user's token. For this, use refresh_token endpoint on a selected user.

Example request

1
2
3
POST https://test-portal.example.com/api/users/619d60a1c54f484885dfdf42c1dc5dbe/refresh_token/
Authorization: Token <Staff Token>
Content-Type: application/json

Body: not required

Example response

Status code: 201

Body:

1
2
3
4
5
6
7
8
9
{
    "created": "2025-02-06T12:14:02.899419Z",
    "token": "1d7e2934d9a158e3046add2869bf63a28cba3b6f",
    "user_first_name": "test",
    "user_is_active": true,
    "user_last_name": "27dd96e5bbc141b3a49f",
    "user_token_lifetime": "3600",
    "user_username": "test_27dd96e5bbc141b3a49f"
}

REST API

Authentication

Waldur uses token-based authentication for REST.

In order to authenticate your requests first obtain token from any of the supported token backends. Then use the token in all the subsequent requests putting it into Authorization header:

1
2
3
4
GET /api/projects/ HTTP/1.1
Accept: application/json
Authorization: Token c84d653b9ec92c6cbac41c706593e66f567a7fa4
Host: example.com

Also token can be put as request GET parameter, with key x-auth-token:

1
2
3
GET /api/?x-auth-token=Token%20144325be6f45e1cb1a4e2016c4673edaa44fe986 HTTP/1.1
Accept: application/json
Host: example.com

API version

In order to retrieve current version of the Waldur authenticated user should send a GET request to /api/version/.

Valid request example (token is user specific):

1
2
3
4
5
GET /api/version/ HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Token c84d653b9ec92c6cbac41c706593e66f567a7fa4
Host: example.com

Valid response example:

1
2
3
4
5
6
7
8
HTTP/1.0 200 OK
Content-Type: application/json
Vary: Accept
Allow: OPTIONS, GET

{
    "version": "0.3.0"
}

Pagination

Every Waldur REST request supports pagination. Links to the next, previous, first and last pages are included in the Link header. X-Result-Count contains a count of all entries in the response set.

By default page size is set to 10. Page size can be modified by passing ?page_size=N query parameter. The maximum page size is 100.

Example of the header output for user listing:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
HTTP/1.0 200 OK
Vary: Accept
Content-Type: application/json
Link:
 <http://example.com/api/users/?page=1>; rel="first",
 <http://example.com/api/users/?page=3>; rel="next",
 <http://example.com/api/users/?page=1>; rel="prev",
 <http://example.com/api/users/?page=6>; rel="last"
X-Result-Count: 54
Allow: GET, POST, HEAD, OPTIONS

Common operations

If you are integrating a python-based application, you might find useful a python wrapper for typical operations.

Almost all operations require authentication. Authentication process is a two-step:

  1. Generation of authentication token using Authentication API.
  2. Passing that token in the Authorization header along with all other REST API calls.

Please note that all of the responses to the listing are paginated, by default up to 10 elements are returned. You can request more by passing page_size=<number> argument, number up to 200 will be respected. Information about the whole set is contained in the response headers. Check example of a "get_all" function to see how a full traversal can be done.

Project management

Customer lookup

Waldur implements a multi-tenant model to allow different organizations to allocate shared resources simultaneously and independently from each other. Each such organizaton is a customer of Waldur and is able to create its own projects. Project allows us to create new allocations as well as connect users with the project.

Hence, to create a project, one needs first to have a reference to the customer. The reference is a stable one and can be cached by a REST API client.

Examples:

Project creation

In order to create a new project in an organization, user needs to provide the following fields:

  • customer - URL of the project's organization
  • name - project's name
  • description - description of a project description
  • end_date - optional date when the project and all allocations it contains will be scheduled for termination.
  • backend_id - optional identifier, which is intended to be unique in the resource allocator's project list. Can be used for connecting Waldur projects with the client's project registry.
  • oecd_fos_2007_code - optional OECD Field of Science code. A code is represented by a string with two numbers separated by dot for a corresponding field of science. For example "1.1" is code for Mathematics. More information can be found here.

Please note that the project becomes active at the moment of creation!

Examples:

Project update

It is possible to update an existing project using its URL link. Name, description and backend_id can be updated.

Examples:

Project lookup

User can list projects and filter them using the following query parameters:

  • name - project's name (uses 'contains' logic for lookup)
  • name_exact - project's exact name
  • description - project's description (uses 'contains' logic for lookup)
  • backend_id - project's exact backend ID

In case API user has access to more than one customer, extra filter by customer properties can be added:

  • customer - exact filter by customer UUID
  • customer_name - filter by partial match of the full name of a customer
  • abbreviation - filter by partial match of the abbreviation of a customer

Examples:

Project membership management

Creating a membership for a user means creating a permission link. While multiple roles of a user per project are allowed, we recommed for clarity to have one active project role per user in a project.

The list of fields for creation are:

  • user - a user's UUID, looked up from a previous step.
  • role - a role of the user. Both role UUID and name are supported. By default the system roles 'PROJECT.MEMBER', 'PROJECT.ADMIN' and 'PROJECT.MANAGER' are supported. TODO: add reference to Puhuri terminology.
  • expiration_time - an optional field, if provided, it should contain date or ISO 8601 datetime.

To remove the permission, REST API client needs to send a HTTP request using the same payload as for permission creation, but to delete_user endpoint .

It is also possible to list available project permissions along with a role filter.

Examples:

Resource allocation management

Creating and managing resource allocations in Waldur follows ordering logic.

All operations on resources, which lead to changes in allocations - e.g. creation, modification of allocated limits or termination - are wrapped in an order.

Listing offerings

To create a new Allocation, one must first choose a specific Offering from available. Offering corresponds to a specific part of a shared resource that Resource Allocator can allocate. Offerings can be visible to multiple allocators, however in the first iteration we plan to limit allocators with access to only their owned shares.

User can fetch offerings and filter them by the following fields:

  • name - offering's name
  • name_exact - offering's exact name
  • customer - organization's URL
  • customer_uuid - organization's UUID

Generally Offering has a stable UUID, which can be used in Waldur client configuration. Offering defines inputs that are required to provision an instance of the offering, available accounting plans (at least one should be present) as well as attributes that can or should be provided with each request.

Each Offering contains one or more plans, you will need to provide a reference (URL) to the plan when creating an allocation.

API examples:

Orders and resources

To create a new allocation, an order must be created with requested attributes: project as well as details about the allocations.

Order might require additional approvals - in this case upon creation its status will be pending-consumer or pending-provider, which can transition to REJECTED if order is rejected. Otherwise it will be switched to EXECUTING, ending either in DONE if all is good or ERRED, if error happens during the processing.

Resource UUID is available as a marketplace_resource_uuid field of the creation order.

In addition, accepting_terms_of_service flag must be provided as a lightweight confirmation that allocator is aware and agreeing with Terms of services of a specific Offering.

Example of the order payload sent with POST to https://puhuri-core-beta.neic.no/api/marketplace-orders/:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
   "project": "https://puhuri-core-beta.neic.no/api/projects/72fff2b5f09643bdb1fa30684427336b/",
   "offering": "https://puhuri-core-beta.neic.no/api/marketplace-public-offerings/0980e9426d5247a0836ccfd64769d900/",
   "attributes": {
      "name": "test20",
   },
   "limits":{
      "gb_k_hours": 30,
      "cpu_k_hours": 1,
      "gpu_k_hours": 20
   },
   "plan": "https://puhuri-core-beta.neic.no/api/marketplace-public-plans/14b28e3a1cbe44b395bad48de9f934d8/",
   "accepting_terms_of_service": true
}

Change resource limits

Send POST request to https://puhuri-core-beta.neic.no/api/marketplace-resources/<UUID_OF_A_RESOURCE>/update_limits/ providing the new values of limits, for example:

1
2
3
4
5
6
7
{
   "limits": {
      "gb_k_hours": 35,
      "cpu_k_hours": 6,
      "gpu_k_hours": 200
   }
}

Resource termination

Send POST request to https://puhuri-core-beta.neic.no/api/marketplace-resources/<UUID_OF_A_RESOURCE>/terminate/.

API examples:

Example integrations:

Reporting

Getting usage data of a specific resource allocation

To get reported usage for resources, send GET request to https://puhuri-core-beta.neic.no/api/marketplace-component-usages/. If you want to get usage data of a specific resource, please add a filter, e.g. https://puhuri-core-beta.neic.no/api/marketplace-component-usages/?resource_uuid=<UUID_OF_A_RESOURCE>. Note that responses are paginated.

Additional filters that can be used:

  • date_before - date of the returned usage records should be before or equal to provided, format YYYY-MM-DD, e.g. 2021-03-01.
  • date_after - date of the returned usage records should be later or equal to provided, format YYYY-MM-DD, e.g. 2021-03-01.
  • offering_uuid - return usage records only for a specified offering.
  • type - type of the usage record to return, e.g. 'cpu_k_hours'.

Response will contain a list of usage records with a separate record for each component per month, for example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
  {
    "uuid": "15a7a55fc78d44f995a6735b1f0f0c86",
    "created": "2021-11-26T20:30:21.348221Z",
    "description": "",
    "type": "cpu_k_hours",
    "name": "CPU allocation",
    "measured_unit": "CPU kH",
    "usage": 12,
    "date": "2021-11-26T20:30:21.342018Z",
    "resource_name": "Sample allocation",
    "resource_uuid": "4e4b8910b3df4ca0969871922eed8f3d",Waldur
    "offering_name": "LUMI UoI / Fast Track Access for Industry Access",
    "offering_uuid": "abe3c5e7cbe14d97a3208c56a22251f4",
    "project_name": "University of Iceland / Sample project",
    "project_uuid": "e1ffec53fd494d438fcb71daee1ae375",
    "customer_name": "University of Iceland",
    "customer_uuid": "6b4aba63ed47472e9cee84dac500cf11",
    "recurring": false,
    "billing_period": "2021-11-01"
  },
  {
    "uuid": "2b90e7f5f91d41b7838bc0d45093dd23",
    "created": "2021-11-26T20:30:21.383305Z",
    "description": "",
    "type": "gb_k_hours",
    "name": "Storage allocation",
    "measured_unit": "GB kH",
    "usage": 34,
    "date": "2021-11-26T20:30:21.342018Z",
    "resource_name": "Sample allocation",
    "resource_uuid": "4e4b8910b3df4ca0969871922eed8f3d",
    "offering_name": "LUMI UoI / Fast Track Access for Industry Access",
    "offering_uuid": "abe3c5e7cbe14d97a3208c56a22251f4",
    "project_name": "University of Iceland / Sample project",
    "project_uuid": "e1ffec53fd494d438fcb71daee1ae375",
    "customer_name": "University of Iceland",
    "customer_uuid": "6b4aba63ed47472e9cee84dac500cf11",
    "recurring": false,
    "billing_period": "2021-11-01"
  }

Authentication

Outline:

Waldur MasterMind exposes REST API for all of its operations. Below are examples of typical operations performed against APIs. To run the examples, we are using a HTTPie.

Almost all of the operations with API require an authentication token. Below we list two methods on how to get it.

Authentication with username and password

If your account is allowed to use username/password and the method is enabled (e.g. in dev environment), you can get a new token by submitting a username/password as JSON to a specific endpoint.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
$ http -v POST https://waldur.example.com/api-auth/password/ username=user password=password

POST /api-auth/password/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 40
Content-Type: application/json
Host: waldur.example.com
User-Agent: HTTPie/2.3.0

{
    "password": "user",
    "username": "password"
}

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: POST, OPTIONS
Content-Language: en
Content-Length: 52
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Mon, 05 Apr 2021 14:37:55 GMT
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "token": "65b4c4f5e25f0cadb3e11c181be4ffa3881741f8"
}

Authentication Token management

The easiest way to obtain your token is via Waldur HomePort.

Open your user dashboard by clicking on your name in the upper left corner, then select Credentials -> API token.

Credentials

A page with your API token will open. Click on the eye icon to reveal the token.

API token

Permissions

Listing permissions

Entities of Waldur are grouped into organisational units. The following organisational units are supported: customer and project.

Each organisational unit has a list of users associated with it. Getting a list of users connected to a certain organisational unit is done through running a GET request against a corresponding endpoint.

  • customer: endpoint /api/customer-permissions/
  • project: endpoint /api/project-permissions/

Filtering by organisational unit UUID or URL is supported. Depending on the type, filter field is one of:

  • ?customer=<UUID>
  • ?customer_url=<URL>
  • ?project=<UUID>
  • ?project_url=<URL>
  • ?user_url=<URL>

In addition, filtering by field names is supported. In all cases filtering is based on case insensitive partial matching.

  • ?username=<username>
  • ?full_name=<full name>
  • ?native_name=<native name>

Ordering can be done by setting an ordering field with ?o=<field_name>. For descending ordering prefix field name with a dash (-). Supported field names are:

  • ?o=user__username
  • ?o=user__full_name
  • ?o=user__native_name

Fetch user data from Waldur using username

To fetch user data together with its permissions, you need to perform the following HTTP request. It requires username filter and valid API token.

1
2
3
4
GET /api/users/?username=<USERNAME>&field=uuid&field=customer_permissions&field=project_permissions
Accept: application/json
Authorization: Token <API_TOKEN>
Host: example.com

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
> http -v --pretty all GET  http://example.com:8000/api/users/ username==admin field==uuid field==customer_permissions field==project_permissions Authorization:"Token 154f2c6984b5992928b62f87950ac529f1f906ca"

GET /api/users/?username=admin&field=uuid&field=customer_permissions&field=project_permissions HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token 154f2c6984b5992928b62f87950ac529f1f906ca
Connection: keep-alive
Host: example.com:8000
User-Agent: HTTPie/2.4.0



HTTP/1.1 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 702
Content-Type: application/json
Date: Tue, 15 Feb 2022 13:07:10 GMT
Link: <http://example.com:8000/api/users/?field=uuid&field=customer_permissions&field=project_permissions&username=admin>; rel="first", <http://example.com:8000/api/users/?field=uuid&field=customer_permissions&field=project_permissions&username=admin>; rel="last"
Server: WSGIServer/0.2 CPython/3.8.2
Vary: Accept, Accept-Language, Cookie, Origin
X-Frame-Options: DENY
X-Result-Count: 1

[
    {
        "customer_permissions": [
            {
                "customer_abbreviation": "",
                "customer_name": "Admin org",
                "customer_native_name": "",
                "customer_uuid": "c9c8685ad4b1427aab2b6c9d36504f84",
                "pk": 8,
                "role": "owner",
                "url": "http://example.com:8000/api/customer-permissions/8/"
            },
            {
                "customer_abbreviation": "",
                "customer_name": "aaaaa",
                "customer_native_name": "",
                "customer_uuid": "7dd7481695e347a4bc80744b0f894c00",
                "pk": 9,
                "role": "owner",
                "url": "http://example.com:8000/api/customer-permissions/9/"
            }
        ],
        "project_permissions": [
            {
                "customer_name": "aaaaa",
                "pk": 40,
                "project_name": "a project",
                "project_uuid": "17db88c53b894aaca8314a2a0ebfda62",
                "role": "admin",
                "url": "http://example.com:8000/api/project-permissions/40/"
            }
        ],
        "uuid": "3c64889f169442d687490addc2a9de30"
    }
]

Project API examples

Lookup allocator customers available to a user

In most cases integration user can see only one allocating organization, however it is possible that the same account is used for allocating different shares, e.g. national share and community specific. Projects are always created in the context of a specific customer, so as a first thing you need to lookup a specific customer you want to use. Customer is a stable entity, so it's URL / UUID can be cached.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
$ http --pretty=format -v https://waldur.com/api/customers/ field==url field==name Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811"
GET /api/customers/?field=url&field=name HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Host: waldur.com
User-Agent: HTTPie/2.4.0



HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 1188
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Fri, 09 Apr 2021 09:28:42 GMT
Link: <https://waldur.com/api/customers/?field=url&field=name>; rel="first", <https://waldur.com/api/customers/?field=url&field=name>; rel="last"
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Result-Count: 9
X-XSS-Protection: 1; mode=block

[
    {
        "name": "Estonian Scientific Computing Infrastructure",
        "url": "https://waldur.com/api/customers/33541d82c56c4eca8dbb1dabee54b3b9/"
    }
]

Create a new project

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
$ http --pretty=format -v POST https://waldur.com/api/projects/ Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811" customer=https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/ name="Project name" description="Project description" backend_id="My unique string" oecd_fos_2007_code="1.1"
POST /api/projects/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Content-Length: 192
Content-Type: application/json
Host: waldur.com
User-Agent: HTTPie/2.4.0

{
    "backend_id": "My unique string",
    "customer": "https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/",
    "description": "Project description",
    "name": "Project name",
    "oecd_fos_2007_code": "1.1"
}

HTTP/1.1 201 Created
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 604
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Fri, 09 Apr 2021 09:40:52 GMT
Location: https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "backend_id": "My unique string",
    "billing_price_estimate": {
        "current": 0,
        "tax": 0,
        "tax_current": 0,
        "total": 0.0
    },
    "created": "2021-04-09T09:40:51.832870Z",
    "customer": "https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/",
    "customer_abbreviation": "DeiC",
    "customer_name": "Danish e-Infrastructure Cooperation",
    "customer_native_name": "",
    "customer_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
    "description": "Project description",
    "name": "Project name",
    "oecd_fos_2007_code": "1.1",
    "type": null,
    "url": "https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/",
    "uuid": "4475ac77fa3a491aacb3fb3a6dfadadf"
}

Update an existing project

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
$ http --pretty=format -v PUT https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/ Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811" name="New project name" customer=https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/
PUT /api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Content-Length: 124
Content-Type: application/json
Host: waldur.com
User-Agent: HTTPie/2.4.0

{
    "customer": "https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/",
    "name": "New project name"
}

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Language: en
Content-Length: 608
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Fri, 09 Apr 2021 09:45:16 GMT
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "backend_id": "My unique string",
    "billing_price_estimate": {
        "current": 0,
        "tax": 0,
        "tax_current": 0,
        "total": 0.0
    },
    "created": "2021-04-09T09:40:51.832870Z",
    "customer": "https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/",
    "customer_abbreviation": "DeiC",
    "customer_name": "Danish e-Infrastructure Cooperation",
    "customer_native_name": "",
    "customer_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
    "description": "Project description",
    "name": "New project name",
    "type": null,
    "url": "https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/",
    "uuid": "4475ac77fa3a491aacb3fb3a6dfadadf"
}

List projects

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
$ http --pretty=format -v https://waldur.com/api/projects/ Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811"
GET /api/projects/ HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Host: waldur.com
User-Agent: HTTPie/2.4.0



HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 7129
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Fri, 09 Apr 2021 09:46:41 GMT
Link: <https://waldur.com/api/projects/>; rel="first", <https://waldur.com/api/projects/?page=2>; rel="next", <https://waldur.com/api/projects/?page=2>; rel="last"
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Result-Count: 20
X-XSS-Protection: 1; mode=block

[
    {
        "backend_id": "",
        "billing_price_estimate": {
            "current": 0,
            "tax": 0,
            "tax_current": 0,
            "total": 0.0
        },
        "created": "2021-03-26T10:57:02.640605Z",
        "customer": "https://waldur.com/api/customers/29f29e6b65004bff9e831dec7c953177/",
        "customer_abbreviation": "OD",
        "customer_name": "Office Department",
        "customer_native_name": "",
        "customer_uuid": "29f29e6b65004bff9e831dec7c953177",
        "description": "test project description",
        "name": "test project",
        "type": "https://waldur.com/api/project-types/c588e4bc82fa4cf0b97e545e117c4c21/",
        "type_name": "Name of project type",
        "url": "https://waldur.com/api/projects/8cb53568cbed40c584029cb43cc540f6/",
        "uuid": "8cb53568cbed40c584029cb43cc540f6"
    }
]

Project members permissions allocation

User creates a role for a user in a project.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
$ http --pretty=format -v POST https://waldur.com/api/projects/2477fb6fad594922ac2f5ba195807502/add_user/ Authorization:"Token b0dd9a5eb32a158b2739d57d2b359aeb30aef246" role=PROJECT.ADMIN user=d213b473874c44d0bb5e2588b091160d
POST /api/projects/2477fb6fad594922ac2f5ba195807502/add_user/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token b0dd9a5eb32a158b2739d57d2b359aeb30aef246
Connection: keep-alive
Content-Length: 69
Content-Type: application/json
Host: waldur.com
User-Agent: HTTPie/3.2.2

{
    "role": "PROJECT.ADMIN",
    "user": "d213b473874c44d0bb5e2588b091160d"
}

HTTP/1.1 201 Created
access-control-allow-credentials: true
access-control-allow-headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With, sentry-trace, baggage
access-control-allow-methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
access-control-allow-origin: *
access-control-expose-headers: Link, X-Result-Count
allow: POST, OPTIONS
content-language: en
content-length: 24
content-security-policy: report-uri https://csp.hpc.ut.ee/log; form-action 'self'; frame-ancestors 'self';
content-type: application/json
date: Sun, 08 Oct 2023 17:28:49 GMT
referrer-policy: strict-origin-when-cross-origin
strict-transport-security: max-age=31536000; preload
vary: Accept-Language, Cookie
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block

{
    "expiration_time": null
}

List project permissions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
$ http --pretty=format -v https://waldur.com/api/projects/2477fb6fad594922ac2f5ba195807502/list_users/ Authorization:"Token b0dd9a5eb32a158b2739d57d2b359aeb30aef246" 
GET /api/projects/2477fb6fad594922ac2f5ba195807502/list_users/ HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token b0dd9a5eb32a158b2739d57d2b359aeb30aef246
Connection: keep-alive
Host: waldur.com
User-Agent: HTTPie/3.2.2



HTTP/1.1 200 OK
access-control-allow-credentials: true
access-control-allow-headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With, sentry-trace, baggage
access-control-allow-methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
access-control-allow-origin: *
access-control-expose-headers: Link, X-Result-Count
allow: GET, HEAD, OPTIONS
content-language: en
content-length: 484
content-security-policy: report-uri https://csp.hpc.ut.ee/log; form-action 'self'; frame-ancestors 'self';
content-type: application/json
date: Sun, 08 Oct 2023 17:29:53 GMT
link: <https://waldur.com/api/projects/2477fb6fad594922ac2f5ba195807502/list_users/>; rel="first", <https://waldur.com/api/projects/2477fb6fad594922ac2f5ba195807502/list_users/>; rel="last"
referrer-policy: strict-origin-when-cross-origin
strict-transport-security: max-age=31536000; preload
vary: Accept-Language, Cookie
x-content-type-options: nosniff
x-frame-options: DENY
x-result-count: 1
x-xss-protection: 1; mode=block

[
    {
        "created": "2023-10-08T17:28:49.565755Z",
        "created_by_full_name": "Demo User",
        "created_by_uuid": "d213b473874c44d0bb5e2588b091160d",
        "expiration_time": null,
        "role_name": "PROJECT.ADMIN",
        "role_uuid": "f734dc56c95e4f8880293defef00079e",
        "user_email": "demo.user@example.com",
        "user_full_name": "Demo User",
        "user_image": null,
        "user_username": "1af2bdea-73db-4790-baa5-5b487b6625f5@myaccessid.org",
        "user_uuid": "d213b473874c44d0bb5e2588b091160d",
        "uuid": "afdda66296c9490ebed72fce4a00d27a"
    }
]

Removal of members from a project

User can remove the permissions calling DELETE verb on permission's URL.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
$ http --pretty=format -v POST https://waldur.com/api/projects/2477fb6fad594922ac2f5ba195807502/delete_user/ Authorization:"Token b0dd9a5eb32a158b2739d57d2b359aeb30aef246" role=PROJECT.ADMIN user=d213b473874c44d0bb5e2588b091160d
POST /api/projects/2477fb6fad594922ac2f5ba195807502/delete_user/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token b0dd9a5eb32a158b2739d57d2b359aeb30aef246
Connection: keep-alive
Content-Length: 69
Content-Type: application/json
Host: waldur.com
User-Agent: HTTPie/3.2.2

{
    "role": "PROJECT.ADMIN",
    "user": "d213b473874c44d0bb5e2588b091160d"
}

HTTP/1.1 200 OK
access-control-allow-credentials: true
access-control-allow-headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With, sentry-trace, baggage
access-control-allow-methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
access-control-allow-origin: *
access-control-expose-headers: Link, X-Result-Count
allow: POST, OPTIONS
content-language: en
content-length: 0
content-security-policy: report-uri https://csp.hpc.ut.ee/log; form-action 'self'; frame-ancestors 'self';
date: Sun, 08 Oct 2023 17:31:32 GMT
referrer-policy: strict-origin-when-cross-origin
strict-transport-security: max-age=31536000; preload
vary: Accept-Language, Cookie
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block

Getting a list of offerings

User can fetch offerings and filter them by the following fields:

  • name - offering's name
  • name_exact - offering's exact name
  • customer - organization's URL
  • customer_uuid - organization's UUID
  • allowed_customer_uuid - allowed organization's UUID
  • service_manager_uuid - service manager's UUID
  • attributes - a set of attributes (key-value pairs) identifying the allocation.
  • state - offering's state (Active, Draft, Paused, Archived), should be Active
  • category_uuid - category's UUID
  • billable - signalizing if an offering is billable or not, should be true
  • shared - signalizing if an offering is public or not, should be true
  • type - offering's type
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
$ http --pretty=format -v https://waldur.com/api/marketplace-public-offerings/ Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811" state==Active shared==true
GET /api/marketplace-public-offerings/?state=Active&shared=true HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Host: waldur.com
User-Agent: HTTPie/2.4.0



HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 4779
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Fri, 09 Apr 2021 12:49:06 GMT
Link: <https://waldur.com/api/marketplace-public-offerings/?shared=true&state=Active>; rel="first", <https://waldur.com/api/marketplace-public-offerings/?shared=true&state=Active>; rel="last"
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Result-Count: 1
X-XSS-Protection: 1; mode=block

[
    {
        "attributes": {},
        "backend_id": "",
        "billable": true,
        "category": "https://waldur.com/api/marketplace-categories/5b61d0811cfe4ed6a004119795a4c532/",
        "category_title": "HPC",
        "category_uuid": "5b61d0811cfe4ed6a004119795a4c532",
        "citation_count": -1,
        "components": [
            {
                "article_code": "",
                "billing_type": "usage",
                "default_limit": null,
                "description": "",
                "disable_quotas": false,
                "factor": null,
                "is_boolean": false,
                "limit_amount": null,
                "limit_period": null,
                "max_value": null,
                "measured_unit": "CPU kH",
                "min_value": null,
                "name": "CPU allocation",
                "type": "cpu_k_hours",
                "use_limit_for_billing": false
            },
            {
                "article_code": "",
                "billing_type": "usage",
                "default_limit": null,
                "description": "",
                "disable_quotas": false,
                "factor": null,
                "is_boolean": false,
                "limit_amount": null,
                "limit_period": null,
                "max_value": null,
                "measured_unit": "CPU kH",
                "min_value": null,
                "name": "GPU allocation",
                "type": "gpu_k_hours",
                "use_limit_for_billing": false
            },
            {
                "article_code": "",
                "billing_type": "usage",
                "default_limit": null,
                "description": "",
                "disable_quotas": false,
                "factor": null,
                "is_boolean": false,
                "limit_amount": null,
                "limit_period": null,
                "max_value": null,
                "measured_unit": "GB kH",
                "min_value": null,
                "name": "Storage allocation",
                "type": "gb_k_hours",
                "use_limit_for_billing": false
            }
        ],
        "created": "2021-03-09T10:27:47.170024Z",
        "customer": "https://waldur.com/api/customers/d42a18b6b8ba4c2bb0591b3ff8fb181d/",
        "customer_name": "Danish e-Infrastructure Cooperation",
        "customer_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
        "datacite_doi": "",
        "description": "",
        "files": [],
        "full_description": "<h2>Overview</h2>One of the most powerful supercomputers in the world",
        "google_calendar_is_public": null,
        "latitude": 64.2310486,
        "longitude": 27.7040942,
        "name": " ",
        "native_description": "",
        "native_name": "",
        "options": {},
        "order_count": 1.0,
        "paused_reason": "",
        "plans": [
            {
                "archived": false,
                "article_code": "",
                "description": "Default plan for all ",
                "init_price": 0,
                "is_active": true,
                "max_amount": null,
                "name": " Common",
                "prices": {
                    "cpu_k_hours": 0.1,
                    "gb_k_hours": 0.001,
                    "gpu_k_hours": 0.5
                },
                "quotas": {
                    "cpu_k_hours": 0,
                    "gb_k_hours": 0,
                    "gpu_k_hours": 0
                },
                "switch_price": 0,
                "unit": "month",
                "unit_price": "0.0000000",
                "url": "https://waldur.com/api/marketplace-public-plans/c0fb33c79e9b48f69fcb6da26db5a28b/",
                "uuid": "c0fb33c79e9b48f69fcb6da26db5a28b"
            }
        ],
        "plugin_options": {
            "auto_approve_in_service_provider_projects": true
        },
        "quotas": null,
        "rating": 5,
        "scope": null,
        "screenshots": [],
        "secret_options": {},
        "shared": true,
        "state": "Active",
        "terms_of_service": "",
        "thumbnail": null,
        "type": "Marketplace.Basic",
        "url": "https://waldur.com/api/marketplace-provider-offerings/073a0ddd6eba4ff4a90b943ae3e1b7c9/",
        "uuid": "073a0ddd6eba4ff4a90b943ae3e1b7c9",
        "vendor_details": ""
    }
]

Creation of a resource allocation

User can create an order providing requested allocation parameters.

  • project - project's UUID
  • offering - respectful offering's URL
  • attributes - specific attributes for the offering
  • plan - plan's URL (if offering is billable)
  • limits - a set of resource limits for an allocation
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
$ http --pretty=format -v POST https://waldur.com/api/marketplace-orders/ Authorization:"Token 32e7682378fa394b0f8b2538c444b60129ebfb47" <<< '{
    "project": "https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/",
    "offering": "https://waldur.com/api/marketplace-public-offerings/073a0ddd6eba4ff4a90b943ae3e1b7c9/",
    "attributes": {
        "name": "Resource allocation1",
        "used_ai_tech": [
            "Deep Learning",
            "Machine Learning"
        ],
        "is_industry": true,
        "is_commercial": false,
        "is_training": false
    },
    "plan": "https://waldur.com/api/marketplace-public-plans/c0fb33c79e9b48f69fcb6da26db5a28b/",
    "limits": {
        "gb_k_hours": 1,
        "gpu_k_hours": 2,
        "cpu_k_hours": 3
    }
}'

POST /api/marketplace-orders/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token 32e7682378fa394b0f8b2538c444b60129ebfb47
Connection: keep-alive
Content-Length: 730
Content-Type: application/json
Host: waldur.com
User-Agent: HTTPie/2.4.0

{
    "attributes": {
        "name": "Resource allocation1",
        "used_ai_tech": [
            "Deep Learning",
            "Machine Learning"
        ],
        "is_industry": true,
        "is_commercial": false,
        "is_training": false
    },
    "limits": {
        "cpu_k_hours": 3,
        "gb_k_hours": 1,
        "gpu_k_hours": 2
    },
    "offering": "https://waldur.com/api/marketplace-public-offerings/073a0ddd6eba4ff4a90b943ae3e1b7c9/",
    "plan": "https://waldur.com/api/marketplace-public-plans/c0fb33c79e9b48f69fcb6da26db5a28b/",
    "project": "https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/",
}

HTTP/1.1 201 Created
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, POST, HEAD, OPTIONS
Content-Language: en
Content-Length: 2114
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Wed, 21 Apr 2021 16:03:08 GMT
Location: https://waldur.com/api/marketplace-orders/d4ba1c23c3de47d6b0ad61bbfbaeed05/
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "approved_at": "2021-04-21T16:03:08.430238Z",
    "approved_by": "https://waldur.com/api/users/3f2cadfbb2b145fd8cf18d549dcd7329/",
    "approved_by_full_name": "Demo Staff",
    "approved_by_username": "admin",
    "created": "2021-04-21T16:03:08.389589Z",
    "created_by": "https://waldur.com/api/users/3f2cadfbb2b145fd8cf18d549dcd7329/",
    "created_by_full_name": "Demo Staff",
    "created_by_username": "admin",
    "customer_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
    "attributes": {
        "name": "Resource allocation1",
        "used_ai_tech": [
            "Deep Learning",
            "Machine Learning"
        ],
        "is_industry": true,
        "is_commercial": false,
        "is_training": false
    },
    "category_title": "HPC",
    "category_uuid": "5b61d0811cfe4ed6a004119795a4c532",
    "cost": "1.3010000000",
    "created": "2021-04-21T16:03:08.402139Z",
    "error_message": "",
    "error_traceback": "",
    "limits": {
        "cpu_k_hours": 3,
        "gb_k_hours": 1,
        "gpu_k_hours": 2
    },
    "modified": "2021-04-21T16:03:08.402139Z",
    "offering": "https://waldur.com/api/marketplace-public-offerings/073a0ddd6eba4ff4a90b943ae3e1b7c9/",
    "offering_billable": true,
    "offering_description": "",
    "offering_name": " ",
    "offering_shared": true,
    "offering_terms_of_service": "",
    "offering_thumbnail": null,
    "offering_type": "Marketplace.Basic",
    "offering_uuid": "073a0ddd6eba4ff4a90b943ae3e1b7c9",
    "output": "",
    "plan": "https://waldur.com/api/marketplace-public-plans/c0fb33c79e9b48f69fcb6da26db5a28b/",
    "plan_description": "Default plan for all ",
    "plan_name": " Common",
    "plan_unit": "month",
    "plan_uuid": "c0fb33c79e9b48f69fcb6da26db5a28b",
    "provider_name": "Danish e-Infrastructure Cooperation",
    "provider_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
    "state": "pending-provider",
    "type": "Create",
    "uuid": "f980c6ae5dc746c5bf5bbf1e31ff7d7e"
    "project": "https://waldur.com/api/projects/4475ac77fa3a491aacb3fb3a6dfadadf/",
    "project_uuid": "4475ac77fa3a491aacb3fb3a6dfadadf",
    "total_cost": "1.3010000000",
    "url": "https://waldur.com/api/marketplace-orders/d4ba1c23c3de47d6b0ad61bbfbaeed05/",
    "uuid": "d4ba1c23c3de47d6b0ad61bbfbaeed05"
}

If a token belongs to a staff user, the order can be approved automatically. Otherwise, there is additional need for manual approval.

After that, order should be pulled until resource UUID is present (marketplace_resource_uuid field).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
$ http --pretty=format -v https://waldur.com/api/marketplace-orders/f980c6ae5dc746c5bf5bbf1e31ff7d7e/ Authorization:"Token 32e7682378fa394b0f8b2538c444b60129ebfb47"
GET /api/marketplace-orders/f980c6ae5dc746c5bf5bbf1e31ff7d7e/ HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token 32e7682378fa394b0f8b2538c444b60129ebfb47
Connection: keep-alive
Host: waldur.com
User-Agent: HTTPie/2.4.0



HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Language: en
Content-Length: 1948
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Wed, 21 Apr 2021 16:04:53 GMT
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "activation_price": 0,
    "attributes": {
        "name": "Resource allocation1",
        "used_ai_tech": [
            "Deep Learning",
            "Machine Learning"
        ],
        "is_industry": true,
        "is_commercial": false,
        "is_training": false
    },
    "can_terminate": false,
    "category_title": "HPC",
    "category_uuid": "5b61d0811cfe4ed6a004119795a4c532",
    "cost": "1.3010000000",
    "created": "2021-04-21T16:03:08.402139Z",
    "created_by_civil_number": null,
    "created_by_full_name": "Demo Staff",
    "customer_name": "Danish e-Infrastructure Cooperation",
    "customer_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
    "error_message": "",
    "error_traceback": "",
    "fixed_price": 0,
    "issue": null,
    "limits": {
        "cpu_k_hours": 3,
        "gb_k_hours": 1,
        "gpu_k_hours": 2
    },
    "marketplace_resource_uuid": "7b0dc0323ce94ebda8670d76a40ebe99",
    "modified": "2021-04-21T16:03:08.542428Z",
    "new_cost_estimate": 1.301,
    "new_plan_name": "Common",
    "new_plan_uuid": "c0fb33c79e9b48f69fcb6da26db5a28b",
    "offering": "https://waldur.com/api/marketplace-public-offerings/073a0ddd6eba4ff4a90b943ae3e1b7c9/",
    "offering_billable": true,
    "offering_description": "Description",
    "offering_name": " ",
    "offering_shared": true,
    "offering_terms_of_service": "",
    "offering_thumbnail": null,
    "offering_type": "Marketplace.Basic",
    "offering_uuid": "073a0ddd6eba4ff4a90b943ae3e1b7c9",
    "old_cost_estimate": 1.301,
    "order_approved_at": "2021-04-21T16:03:08.430238Z",
    "order_approved_by": "Demo Staff",
    "output": "",
    "plan": "https://waldur.com/api/marketplace-public-plans/c0fb33c79e9b48f69fcb6da26db5a28b/",
    "plan_description": "Default plan",
    "plan_name": "Common",
    "plan_unit": "month",
    "plan_uuid": "c0fb33c79e9b48f69fcb6da26db5a28b",
    "project_name": "New project name",
    "project_uuid": "4475ac77fa3a491aacb3fb3a6dfadadf",
    "provider_name": "Danish e-Infrastructure Cooperation",
    "provider_uuid": "d42a18b6b8ba4c2bb0591b3ff8fb181d",
    "resource_name": "Resource allocation1",
    "resource_type": null,
    "resource_uuid": null,
    "state": "done",
    "type": "Create",
    "uuid": "f980c6ae5dc746c5bf5bbf1e31ff7d7e"
}

Order approval and rejection

In order to approve order by consumer, you shall issue POST request against /api/marketplace-orders/{UUID}/approve_by_consumer/ endpoint. Similarly in order to approve order by provider, you shall issue POST request against /api/marketplace-orders/{UUID}/approve_by_provider/ endpoint. Otherwise, you shall issue POST request against /api/marketplace-orders/{UUID}/reject_by_consumer/ or /api/marketplace-orders/{UUID}/reject_by_provider/ endpoint.

Of course, these endpoints are available only if you have service provider or service consumer permission against corresponding offerings.

Modification of a resource allocation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
$ http --pretty=format -v PUT https://waldur.com/api/marketplace-resources/b97e82d0fc2445d493cf5659a3085608/ Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811" name="New resource name" description="New resource description"
PUT /api/marketplace-resources/b97e82d0fc2445d493cf5659a3085608/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Content-Length: 72
Content-Type: application/json
Host: waldur.com
User-Agent: HTTPie/2.4.0

{
    "description": "New resource description",
    "name": "New resource name"
}

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Language: en
Content-Length: 69
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Fri, 09 Apr 2021 15:21:23 GMT
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "description": "New resource description",
    "name": "New resource name"
}

Modification of resource allocation options

As an RA, you can update options of an allocations. Update happens through a special endpoint on a resource.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
http -v POST https://waldur.com/api/marketplace-resources/b97e82d0fc2445d493cf5659a3085608/update_options/ Authorization:"Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811" <<< '{
    "options": {
        "used_ai_tech": [
            "Deep Learning",
            "Machine Learning"
        ],
        "is_training": false
    }
}'
POST /api/marketplace-resources/53cb5c0a34cc41f5ad36b74c760e39f6/update_options/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Token 787de6b7c581ab6d9d42fe9ec12ac9f1811c5811
Connection: keep-alive
Content-Length: 153
Content-Type: application/json
Host: waldur-demo.com
User-Agent: HTTPie/3.2.2

{
    "options": {
        "is_training": false,
        "used_ai_tech": [
            "Deep Learning",
            "Machine Learning"
        ]
    }
}


HTTP/1.1 200 OK
access-control-allow-credentials: true
access-control-allow-headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With, X-Impersonated-User-Uuid, sentry-trace, baggage
access-control-allow-methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
access-control-allow-origin: *
access-control-expose-headers: Link, X-Result-Count
allow: POST, OPTIONS
content-language: en
content-length: 43
content-security-policy: report-uri https://csp.hpc.ut.ee/log; form-action 'self'; frame-ancestors 'self';
content-type: application/json
date: Tue, 27 Aug 2024 09:18:29 GMT
referrer-policy: strict-origin-when-cross-origin
strict-transport-security: max-age=31536000; preload
vary: Accept-Language, Cookie
x-content-type-options: nosniff
x-frame-options: DENY
x-rate-limit-limit: 500
x-rate-limit-remaining: 488
x-xss-protection: 1; mode=block

{
    "status": "Resource options are submitted"
}

Termination of a resource allocation

Termination uses a special short-cut action /terminate and returns UUID of a generated order.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
$ http -v POST https://waldur.com/api/marketplace-resources/8887243fa8d0458c970eeb6be28ff4f7/terminate/ Authorization:"Token 32e7682378fa394b0f8b2538c444b60129ebfb47"
POST /api/marketplace-resources/8887243fa8d0458c970eeb6be28ff4f7/terminate/ HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token 32e7682378fa394b0f8b2538c444b60129ebfb47
Connection: keep-alive
Content-Length: 0
Host: waldur.com
User-Agent: HTTPie/2.4.0



HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Accept, Accept-Encoding, Authorization, Content-Type, Origin, User-Agent, X-CSRFToken, X-Requested-With
Access-Control-Allow-Methods: DELETE, GET, OPTIONS, PATCH, POST, PUT
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Link, X-Result-Count
Allow: POST, OPTIONS
Content-Language: en
Content-Length: 49
Content-Security-Policy: report-uri csp.hpc.ut.ee; form-action 'self';
Content-Type: application/json
Date: Wed, 14 Apr 2021 22:28:07 GMT
Referrer-Policy: no-referrer-when-downgrade
Strict-Transport-Security: max-age=31536000; preload
Vary: Accept-Language, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
    "order_uuid": "7c73504611d741749b3a3a538979e74a"
}

Waldur SDK Documentation

This document provides information about official Waldur SDK libraries available in multiple programming languages. All SDK clients are automatically generated from OpenAPI schema, ensuring consistency across different implementations.

Available SDKs

Python SDK

  • Repository: waldur/py-client
  • Auto-generated Python client for Waldur REST API
  • Installation:
1
pip install waldur-api-client

TypeScript/JavaScript SDK

  • Repository: waldur/js-client
  • Auto-generated TypeScript/JavaScript client for Waldur REST API
  • Installation:
1
npm install waldur-js-client

Go SDK

  • Repository: waldur/go-client
  • Auto-generated Go client for Waldur REST API
  • Installation:
1
go get github.com/waldur/go-client

Features

  • Auto-generated from OpenAPI specification
  • Type-safe API interfaces
  • Comprehensive API coverage
  • Regular updates following Waldur API changes

OpenAPI schema diff - 7.4.8

For version 7.4.8

New Endpoints: 5

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/
POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/
POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/
POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/
POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

Deleted Endpoints: None

Modified Endpoints: 429

POST /api-auth/password/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api-auth/saml2/login/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api-auth/saml2/login/complete/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api-auth/saml2/logout/complete/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/access-subnets/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/access-subnets/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/access-subnets/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/admin-announcements/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/admin-announcements/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/admin-announcements/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/auth-valimo/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/auth-valimo/result/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/aws-instances/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/aws-instances/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/aws-instances/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/aws-instances/{uuid}/resize/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/aws-volumes/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/aws-volumes/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/aws-volumes/{uuid}/attach/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/azure-public-ips/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/azure-public-ips/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/azure-public-ips/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/azure-sql-databases/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/azure-sql-databases/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/azure-sql-databases/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/azure-sql-servers/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/azure-sql-servers/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/azure-sql-servers/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/azure-sql-servers/{uuid}/create_database/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/azure-virtualmachines/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/azure-virtualmachines/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/azure-virtualmachines/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/booking-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
          • Nullable changed from false to true
        • Modified property: customer_uuid
          • Nullable changed from false to true
        • Modified property: parent_description
          • Nullable changed from false to true
        • Modified property: parent_name
          • Nullable changed from false to true
        • Modified property: parent_uuid
          • Nullable changed from false to true
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
          • Nullable changed from false to true
        • Modified property: project_uuid
          • Nullable changed from false to true

GET /api/booking-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/broadcast-message-templates/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/broadcast-message-templates/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/broadcast-message-templates/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/broadcast-messages/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/broadcast-messages/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/broadcast-messages/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/call-managing-organisations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/call-managing-organisations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/call-managing-organisations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/call-managing-organisations/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/call-managing-organisations/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/call-managing-organisations/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/component-user-usage-limits/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/component-user-usage-limits/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/component-user-usage-limits/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/customer-credits/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/customer-credits/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/customer-credits/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/customer-credits/{uuid}/apply_compensations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/customer-credits/{uuid}/clear_compensations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/customers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: call_managing_organization_uuid
          • Nullable changed from false to true
        • Modified property: service_provider
          • Nullable changed from false to true
        • Modified property: service_provider_uuid
          • Nullable changed from false to true

POST /api/customers/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: call_managing_organization_uuid
        • Nullable changed from false to true
        • Modified property: service_provider
        • Nullable changed from false to true
        • Modified property: service_provider_uuid
        • Nullable changed from false to true

POST /api/customers/{customer_uuid}/marketplace-checklists/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: call_managing_organization_uuid
        • Nullable changed from false to true
        • Modified property: service_provider
        • Nullable changed from false to true
        • Modified property: service_provider_uuid
        • Nullable changed from false to true

PATCH /api/customers/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: call_managing_organization_uuid
        • Nullable changed from false to true
        • Modified property: service_provider
        • Nullable changed from false to true
        • Modified property: service_provider_uuid
        • Nullable changed from false to true

PUT /api/customers/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: call_managing_organization_uuid
        • Nullable changed from false to true
        • Modified property: service_provider
        • Nullable changed from false to true
        • Modified property: service_provider_uuid
        • Nullable changed from false to true

POST /api/customers/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/customers/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/customers/{uuid}/stats/

  • New query param: for_current_month

POST /api/customers/{uuid}/update_organization_groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/customers/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/digitalocean-droplets/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/digitalocean-droplets/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/digitalocean-droplets/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/digitalocean-droplets/{uuid}/resize/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/event-subscriptions/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/feature-values/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/freeipa-profiles/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/freeipa-profiles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [resource_robot_account_state_changed]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [resource_robot_account_state_changed]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [resource_robot_account_state_changed]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [resource_robot_account_state_changed]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [resource_robot_account_state_changed]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [resource_robot_account_state_changed]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [resource_robot_account_state_changed]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [resource_robot_account_state_changed]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [resource_robot_account_state_changed]

POST /api/identity-providers/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/identity-providers/{provider}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/identity-providers/{provider}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/invoice-items/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/invoice-items/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/invoice-items/{uuid}/create_compensation/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/invoice-items/{uuid}/migrate_to/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/invoice/send-financial-report-by-mail/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/invoices/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [compensations incurred_costs]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: compensations
        • New property: incurred_costs

GET /api/invoices/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [compensations incurred_costs]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compensations
        • New property: incurred_costs

POST /api/invoices/{uuid}/paid/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compensations
        • New property: incurred_costs

POST /api/invoices/{uuid}/set_backend_id/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/invoices/{uuid}/set_payment_url/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/invoices/{uuid}/set_reference_number/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/keys/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/lexis-links/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/lexis-links/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/lexis-links/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-categories/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-categories/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-categories/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-category-columns/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-category-columns/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-category-columns/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-category-components/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-category-components/{id}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-category-components/{id}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-category-groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-category-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-category-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-category-help-articles/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-category-help-articles/{id}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-category-help-articles/{id}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-checklists/{checklist_uuid}/answers/submit/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-component-usages/set_usage/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-component-usages/{uuid}/set_user_usage/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-customer-estimated-cost-policies/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-customer-estimated-cost-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-customer-estimated-cost-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-offering-estimated-cost-policies/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-offering-estimated-cost-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-offering-estimated-cost-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-offering-files/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-offering-usage-policies/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-offering-usage-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-offering-usage-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-offering-user-roles/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-offering-user-roles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-offering-user-roles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-offering-users/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-offering-users/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-offering-users/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-offering-users/{uuid}/update_restricted/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-orders/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/marketplace-orders/{uuid}/set_state_erred/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-plans/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-plans/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-plans/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-plans/{uuid}/update_organization_groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-plans/{uuid}/update_prices/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-plans/{uuid}/update_quotas/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-project-estimated-cost-policies/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-project-estimated-cost-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-project-estimated-cost-policies/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-project-update-requests/{uuid}/approve/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-project-update-requests/{uuid}/reject/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-provider-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
          • Nullable changed from false to true
        • Modified property: customer_uuid
          • Nullable changed from false to true
        • Modified property: google_calendar_is_public
          • Nullable changed from false to true
        • Modified property: integration_status
          • Nullable changed from false to true
        • Modified property: parent_description
          • Nullable changed from false to true
        • Modified property: parent_name
          • Nullable changed from false to true
        • Modified property: parent_uuid
          • Nullable changed from false to true
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
          • Nullable changed from false to true
        • Modified property: project_uuid
          • Nullable changed from false to true
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: scope_error_message
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

GET /api/marketplace-provider-offerings/groups/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

GET /api/marketplace-provider-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/add_endpoint/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/create_offering_component/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/delete_endpoint/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/pause/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/remove_offering_component/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/update_attributes/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_description/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plugin_options
        • Properties changed
        • New property: openstack_offering_uuid_list
      • Modified property: secret_options
        • Properties changed
        • New property: rancher_offering_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Properties changed
          • New property: openstack_offering_uuid_list
        • Modified property: secret_options
        • Properties changed
          • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/update_location/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_options/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_organization_groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/update_overview/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_resource_options/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-offerings/{uuid}/update_thumbnail/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

POST /api/marketplace-provider-offerings/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: integration_status
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: rancher_offering_uuid

PATCH /api/marketplace-provider-resources/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-provider-resources/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_as_erred/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_as_ok/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_backend_id/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_backend_metadata/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_limits/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/set_slug/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/submit_report/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-provider-resources/{uuid}/terminate/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-public-api/check_signature/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-public-api/set_usage/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-public-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
          • Nullable changed from false to true
        • Modified property: customer_uuid
          • Nullable changed from false to true
        • Modified property: google_calendar_is_public
          • Nullable changed from false to true
        • Modified property: parent_description
          • Nullable changed from false to true
        • Modified property: parent_name
          • Nullable changed from false to true
        • Modified property: parent_uuid
          • Nullable changed from false to true
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
          • Nullable changed from false to true
        • Modified property: project_uuid
          • Nullable changed from false to true

GET /api/marketplace-public-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [scope_error_message]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/marketplace-remote-synchronisations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-remote-synchronisations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-remote-synchronisations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resource-users/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resources/suggest_name/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-resources/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-resources/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/marketplace-resources/{uuid}/set_end_date_by_staff/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resources/{uuid}/set_slug/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resources/{uuid}/switch_plan/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resources/{uuid}/terminate/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resources/{uuid}/update_limits/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-resources/{uuid}/update_options/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-robot-accounts/

  • New query param: state
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: error_message
        • New required property: error_traceback
        • New required property: state
        • Properties changed
        • New property: error_message
        • New property: error_traceback
        • New property: state
        • Modified property: offering_plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: openstack_offering_uuid_list

POST /api/marketplace-robot-accounts/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: error_message
        • New required property: error_traceback
        • New required property: state
      • Properties changed
        • New property: error_message
        • New property: error_traceback
        • New property: state

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: error_message
        • New required property: error_traceback
        • New required property: state
      • Properties changed
        • New property: error_message
        • New property: error_traceback
        • New property: state
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list

PATCH /api/marketplace-robot-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: error_message
        • New required property: error_traceback
        • New required property: state
      • Properties changed
        • New property: error_message
        • New property: error_traceback
        • New property: state

PUT /api/marketplace-robot-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: error_message
        • New required property: error_traceback
        • New required property: state
      • Properties changed
        • New property: error_message
        • New property: error_traceback
        • New property: state

POST /api/marketplace-screenshots/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-screenshots/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-screenshots/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: scope_error_message
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: google_calendar_is_public
        • Nullable changed from false to true
        • Modified property: parent_description
        • Nullable changed from false to true
        • Modified property: parent_name
        • Nullable changed from false to true
        • Modified property: parent_uuid
        • Nullable changed from false to true
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: openstack_offering_uuid_list
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true

POST /api/marketplace-script-sync-resource/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-sections/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/marketplace-sections/{key}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-sections/{key}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-service-providers/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: rancher_offering_uuid

PATCH /api/marketplace-service-providers/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/marketplace-service-providers/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-service-providers/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-service-providers/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-service-providers/{uuid}/set_offerings_username/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/marketplace-service-providers/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/notification-messages-templates/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/notification-messages-templates/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/notification-messages-templates/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/notification-messages-templates/{uuid}/override/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/notification-messages/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/notification-messages/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/notification-messages/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-backups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-backups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-backups/{uuid}/restore/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: volumes
        • Items changed
          • Properties changed
          • Modified property: marketplace_resource_uuid
            • Nullable changed from false to true

GET /api/openstack-floating-ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance_name
          • Nullable changed from false to true
        • Modified property: instance_url
          • Nullable changed from false to true
        • Modified property: instance_uuid
          • Nullable changed from false to true

GET /api/openstack-floating-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_name
        • Nullable changed from false to true
        • Modified property: instance_url
        • Nullable changed from false to true
        • Modified property: instance_uuid
        • Nullable changed from false to true

POST /api/openstack-floating-ips/{uuid}/attach_to_port/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-floating-ips/{uuid}/update_description/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: volumes
          • Items changed
          • Properties changed
            • Modified property: marketplace_resource_uuid
            • Nullable changed from false to true

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: volumes
        • Items changed
          • Properties changed
          • Modified property: marketplace_resource_uuid
            • Nullable changed from false to true

PATCH /api/openstack-instances/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: volumes
        • Items changed
          • Properties changed
          • Modified property: marketplace_resource_uuid
            • Nullable changed from false to true

PUT /api/openstack-instances/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: volumes
        • Items changed
          • Properties changed
          • Modified property: marketplace_resource_uuid
            • Nullable changed from false to true

POST /api/openstack-instances/{uuid}/backup/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-instances/{uuid}/change_flavor/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-instances/{uuid}/update_allowed_address_pairs/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-instances/{uuid}/update_floating_ips/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-instances/{uuid}/update_ports/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-instances/{uuid}/update_security_groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-migrations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-migrations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-migrations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-networks/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-networks/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-networks/{uuid}/create_port/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-networks/{uuid}/create_subnet/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-networks/{uuid}/set_mtu/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-routers/{uuid}/set_routes/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-security-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-security-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-security-groups/{uuid}/set_rules/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-server-groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-server-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-server-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-snapshots/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-snapshots/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-snapshots/{uuid}/restore/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-subnets/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-subnets/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-tenants/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-tenants/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-tenants/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-tenants/{uuid}/change_password/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-tenants/{uuid}/create_floating_ip/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_name
        • Nullable changed from false to true
        • Modified property: instance_url
        • Nullable changed from false to true
        • Modified property: instance_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_network/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-tenants/{uuid}/create_server_group/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-tenants/{uuid}/set_quotas/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/openstack-volumes/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/openstack-volumes/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-volumes/{uuid}/attach/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-volumes/{uuid}/extend/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-volumes/{uuid}/retype/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/openstack-volumes/{uuid}/snapshot/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/organization-groups/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/organization-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/organization-groups/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/payment-profiles/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/payment-profiles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/payment-profiles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/payments/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/payments/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/payments/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/payments/{uuid}/link_to_invoice/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/project-credits/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/project-credits/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/project-credits/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/projects/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/projects/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/projects/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/projects/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/projects/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/projects/{uuid}/move_project/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

GET /api/projects/{uuid}/stats/

  • Description changed from '' to 'Return statistics about project resources usage'
  • New query param: for_current_month

POST /api/projects/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/promotions-campaigns/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/promotions-campaigns/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/approve/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/attach_document/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/reject/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/resources/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/update_project_details/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-proposals/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/add_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/attach_documents/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/delete_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/detach_documents/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/offerings/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/rounds/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-protected-calls/{uuid}/update_user/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-reviews/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/proposal-reviews/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/proposal-reviews/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/proposal-reviews/{uuid}/submit/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/query/

  • Description changed from '' to 'Execute SQL query against readonly database'
  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data
  • Responses changed
  • New response: 400
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Type changed from 'object' to 'array'
      • Items changed
        • Schema added
      • Required changed
        • Deleted required property: query
      • Properties changed
        • Deleted property: query

POST /api/rancher-apps/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-apps/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-apps/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-catalogs/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-catalogs/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-catalogs/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-catalogs/{uuid}/refresh/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-clusters/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-clusters/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-clusters/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-clusters/{uuid}/import_yaml/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-hpas/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-hpas/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-hpas/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-hpas/{uuid}/yaml/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-ingresses/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-ingresses/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-ingresses/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-ingresses/{uuid}/yaml/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-nodes/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-nodes/{uuid}/link_openstack/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-services/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-services/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-services/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-services/{uuid}/yaml/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/rancher-workloads/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/rancher-workloads/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-workloads/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/rancher-workloads/{uuid}/yaml/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/remote-eduteams/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/remote-waldur-api/import_offering/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/remote-waldur-api/remote_categories/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/remote-waldur-api/remote_customers/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/remote-waldur-api/shared_offerings/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/roles/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/roles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/roles/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/roles/{uuid}/update_descriptions/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/slurm-allocations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/slurm-allocations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/slurm-allocations/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/slurm-allocations/{uuid}/set_limits/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/slurm-jobs/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/slurm-jobs/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/slurm-jobs/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-attachments/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/support-comments/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/support-comments/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-feedbacks/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-issues/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/support-issues/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/support-issues/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-issues/{uuid}/comment/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-issues/{uuid}/sync/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-jira-webhook/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-smax-webhook/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-templates/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/support-templates/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/support-templates/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-templates/{uuid}/create_attachments/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/support-templates/{uuid}/delete_attachments/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-agreements/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/user-agreements/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/user-agreements/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-group-invitations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-invitations/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-invitations/approve/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-invitations/reject/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-permission-requests/{uuid}/approve/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/user-permission-requests/{uuid}/reject/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/users/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/users/confirm_email/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/users/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/users/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/users/{uuid}/change_email/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/users/{uuid}/change_password/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/vmware-disks/{uuid}/extend/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/vmware-virtual-machine/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PATCH /api/vmware-virtual-machine/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

PUT /api/vmware-virtual-machine/{uuid}/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/vmware-virtual-machine/{uuid}/create_disk/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

POST /api/vmware-virtual-machine/{uuid}/create_port/

  • Request body changed
  • Content changed
    • Deleted media type: application/x-www-form-urlencoded
    • Deleted media type: multipart/form-data

OpenAPI schema diff - 7.4.9

For version 7.4.9

New Endpoints: 12

GET /api/keycloak-groups/
GET /api/keycloak-groups/{uuid}/
GET /api/keycloak-user-group-memberships/
POST /api/keycloak-user-group-memberships/
DELETE /api/keycloak-user-group-memberships/{uuid}/
GET /api/keycloak-user-group-memberships/{uuid}/
PATCH /api/keycloak-user-group-memberships/{uuid}/
PUT /api/keycloak-user-group-memberships/{uuid}/
POST /api/openstack-networks/{uuid}/rbac_policy_create/
DELETE /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/
GET /api/rancher-role-templates/
GET /api/rancher-role-templates/{uuid}/

Deleted Endpoints: 10

GET /api/icons/favicon/
GET /api/icons/hero_image/
GET /api/icons/keycloak_icon/
GET /api/icons/login_logo/
GET /api/icons/offering_logo_placeholder/
GET /api/icons/powered_by_logo/
GET /api/icons/sidebar_logo/
GET /api/icons/sidebar_logo_dark/
GET /api/icons/sidebar_logo_mobile/
GET /api/icons/site_logo/

Modified Endpoints: 141

GET /api/aws-instances/

  • New query param: can_manage

GET /api/azure-public-ips/

  • New query param: can_manage

GET /api/azure-sql-databases/

  • New query param: can_manage

GET /api/azure-sql-servers/

  • New query param: can_manage

GET /api/azure-virtualmachines/

  • New query param: can_manage

GET /api/booking-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
              • Items changed
              • Format changed from 'uuid' to ''

GET /api/booking-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

GET /api/booking-resources/

  • New query param: offering_shared
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true

GET /api/booking-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

POST /api/call-managing-organisations/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/call-managing-organisations/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/customers/

  • New query param: owned_by_current_user

GET /api/customers/countries/

  • New query param: owned_by_current_user

POST /api/customers/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/customers/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/digitalocean-droplets/

  • New query param: can_manage

GET /api/financial-reports/

  • New query param: owned_by_current_user

GET /api/marketplace-orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: consumer_reviewed_by
          • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_full_name
          • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_username
          • Nullable changed from false to true
        • Modified property: new_plan_name
          • Nullable changed from false to true
        • Modified property: new_plan_uuid
          • Nullable changed from false to true
        • Modified property: old_plan_name
          • Nullable changed from false to true
        • Modified property: old_plan_uuid
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by_full_name
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by_username
          • Nullable changed from false to true

POST /api/marketplace-orders/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: consumer_reviewed_by_full_name
        • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_username
        • Nullable changed from false to true

GET /api/marketplace-orders/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: consumer_reviewed_by
        • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_full_name
        • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_username
        • Nullable changed from false to true
        • Modified property: new_plan_name
        • Nullable changed from false to true
        • Modified property: new_plan_uuid
        • Nullable changed from false to true
        • Modified property: old_plan_name
        • Nullable changed from false to true
        • Modified property: old_plan_uuid
        • Nullable changed from false to true
        • Modified property: provider_reviewed_by
        • Nullable changed from false to true
        • Modified property: provider_reviewed_by_full_name
        • Nullable changed from false to true
        • Modified property: provider_reviewed_by_username
        • Nullable changed from false to true

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
              • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
              • Format changed from 'uuid' to ''

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state_code
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/groups/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

POST /api/marketplace-provider-offerings/{uuid}/add_endpoint/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/marketplace-provider-offerings/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/marketplace-provider-offerings/{uuid}/delete_thumbnail/

  • Responses changed
  • New response: 204
  • Deleted response: 200

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: consumer_reviewed_by
          • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_full_name
          • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_username
          • Nullable changed from false to true
        • Modified property: new_plan_name
          • Nullable changed from false to true
        • Modified property: new_plan_uuid
          • Nullable changed from false to true
        • Modified property: old_plan_name
          • Nullable changed from false to true
        • Modified property: old_plan_uuid
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by_full_name
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by_username
          • Nullable changed from false to true

GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: consumer_reviewed_by
        • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_full_name
        • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_username
        • Nullable changed from false to true
        • Modified property: new_plan_name
        • Nullable changed from false to true
        • Modified property: new_plan_uuid
        • Nullable changed from false to true
        • Modified property: old_plan_name
        • Nullable changed from false to true
        • Modified property: old_plan_uuid
        • Nullable changed from false to true
        • Modified property: provider_reviewed_by
        • Nullable changed from false to true
        • Modified property: provider_reviewed_by_full_name
        • Nullable changed from false to true
        • Modified property: provider_reviewed_by_username
        • Nullable changed from false to true

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

POST /api/marketplace-provider-offerings/{uuid}/update_description/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plugin_options
        • Properties changed
        • New property: managed_rancher_server_flavor_name
        • New property: managed_rancher_server_system_volume_size_gb
        • New property: managed_rancher_server_system_volume_type_name
        • Modified property: openstack_offering_uuid_list
          • Items changed
          • Format changed from 'uuid' to ''
          • MinLength changed from 0 to 1
      • Modified property: secret_options
        • Properties changed
        • New property: backend_url
        • New property: cloud_init_template
        • New property: password
        • New property: username
        • Deleted property: rancher_offering_uuid
        • Modified property: customer_uuid
          • Format changed from 'uuid' to ''
          • MinLength changed from 0 to 1
  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_location/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_options/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_organization_groups/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_overview/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_resource_options/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_thumbnail/

  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-offerings/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
            • Format changed from 'uuid' to ''

GET /api/marketplace-provider-resources/

  • New query param: offering_shared
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true

GET /api/marketplace-provider-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

GET /api/marketplace-provider-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/set_as_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/terminate/

  • Description changed from '' to 'Create marketplace order for resource termination.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: order_uuid
      • Properties changed
        • New property: order_uuid
        • Deleted property: attributes

GET /api/marketplace-public-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
              • Items changed
              • Format changed from 'uuid' to ''

GET /api/marketplace-public-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [state_code]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

GET /api/marketplace-resources/

  • New query param: offering_shared
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true

GET /api/marketplace-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

GET /api/marketplace-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: consumer_reviewed_by
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
            • Nullable changed from false to true
            • Modified property: new_plan_name
            • Nullable changed from false to true
            • Modified property: new_plan_uuid
            • Nullable changed from false to true
            • Modified property: old_plan_name
            • Nullable changed from false to true
            • Modified property: old_plan_uuid
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
            • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
            • Nullable changed from false to true

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

POST /api/marketplace-resources/{uuid}/switch_plan/

  • Description changed from '' to 'Create marketplace order for resource plan switch.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: order_uuid
        • Deleted required property: plan
      • Properties changed
        • New property: order_uuid
        • Deleted property: plan

POST /api/marketplace-resources/{uuid}/terminate/

  • Description changed from '' to 'Create marketplace order for resource termination.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: order_uuid
      • Properties changed
        • New property: order_uuid
        • Deleted property: attributes

POST /api/marketplace-resources/{uuid}/update_limits/

  • Description changed from '' to 'Create marketplace order for resource limits update.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: order_uuid
        • Deleted required property: limits
      • Properties changed
        • New property: order_uuid
        • Deleted property: limits

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offering_plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
              • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
          • Nullable changed from false to true

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
        • Nullable changed from false to true

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
        • Nullable changed from false to true

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
        • Nullable changed from false to true

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
        • Nullable changed from false to true

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
        • Nullable changed from false to true

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''
        • Modified property: responsible_user
        • Nullable changed from false to true

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: state_code
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_server_flavor_name
            • New property: managed_rancher_server_system_volume_size_gb
            • New property: managed_rancher_server_system_volume_type_name
            • Modified property: openstack_offering_uuid_list
            • Items changed
              • Format changed from 'uuid' to ''

GET /api/marketplace-service-providers/{service_provider_uuid}/customers/

  • New query param: owned_by_current_user

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: backend_url
            • New property: cloud_init_template
            • New property: password
            • New property: username
            • Deleted property: rancher_offering_uuid
            • Modified property: customer_uuid
              • Format changed from 'uuid' to ''

GET /api/marketplace-service-providers/{service_provider_uuid}/user_customers/

  • New query param: owned_by_current_user

POST /api/marketplace-service-providers/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/marketplace-service-providers/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/openstack-backups/

  • New query param: can_manage
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance_ports
          • Items changed
          • Properties changed
            • Modified property: fixed_ips
            • ReadOnly changed from true to false
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: ports
            • Items changed
              • Properties changed
              • Modified property: fixed_ips
                • ReadOnly changed from true to false

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: fixed_ips
              • ReadOnly changed from true to false

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: fixed_ips
              • ReadOnly changed from true to false

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: fixed_ips
              • ReadOnly changed from true to false

POST /api/openstack-backups/{uuid}/restore/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: ports
        • Items changed
        • Properties changed
          • New property: fixed_ips
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false

GET /api/openstack-floating-ips/

  • New query param: can_manage

GET /api/openstack-instances/

  • New query param: can_manage
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: ports
          • Items changed
          • Properties changed
            • Modified property: fixed_ips
            • ReadOnly changed from true to false

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: fixed_ips
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: fixed_ips
              • ReadOnly changed from true to false

GET /api/openstack-instances/{uuid}/ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: fixed_ips
          • ReadOnly changed from true to false

POST /api/openstack-instances/{uuid}/update_ports/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: ports
        • Items changed
        • Properties changed
          • New property: fixed_ips

GET /api/openstack-migrations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: mappings
          • Properties changed
          • New property: sync_instance_ports

POST /api/openstack-migrations/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: mappings
        • Properties changed
        • New property: sync_instance_ports
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: mappings
        • Properties changed
          • New property: sync_instance_ports

GET /api/openstack-migrations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: mappings
        • Properties changed
          • New property: sync_instance_ports

PATCH /api/openstack-migrations/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: mappings
        • Properties changed
        • New property: sync_instance_ports
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: mappings
        • Properties changed
          • New property: sync_instance_ports

PUT /api/openstack-migrations/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: mappings
        • Properties changed
        • New property: sync_instance_ports
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: mappings
        • Properties changed
          • New property: sync_instance_ports

GET /api/openstack-networks/

  • New query param: can_manage
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [rbac_policies]
  • Modified query param: tenant
  • Description changed from '' to 'Tenant URL'
  • Modified query param: tenant_uuid
  • Description changed from '' to 'Tenant UUID'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: rbac_policies

GET /api/openstack-networks/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [rbac_policies]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: rbac_policies

PATCH /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: rbac_policies

PUT /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: rbac_policies

GET /api/openstack-security-groups/

  • New query param: can_manage

GET /api/openstack-server-groups/

  • New query param: can_manage

GET /api/openstack-snapshots/

  • New query param: can_manage

GET /api/openstack-subnets/

  • New query param: can_manage
  • Modified query param: tenant
  • Description changed from '' to 'Tenant URL'
  • Modified query param: tenant_uuid
  • Description changed from '' to 'Tenant UUID'

GET /api/openstack-tenants/

  • New query param: can_manage

GET /api/openstack-tenants/{uuid}/backend_instances/

  • New query param: can_manage

GET /api/openstack-tenants/{uuid}/backend_volumes/

  • New query param: can_manage

POST /api/openstack-tenants/{uuid}/create_network/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: rbac_policies

GET /api/openstack-volumes/

  • New query param: can_manage

POST /api/projects/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/projects/{uuid}/move_project/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: preserve_permissions
      • Properties changed
      • New property: preserve_permissions

POST /api/projects/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/promotions-campaigns/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: consumer_reviewed_by
          • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_full_name
          • Nullable changed from false to true
        • Modified property: consumer_reviewed_by_username
          • Nullable changed from false to true
        • Modified property: new_plan_name
          • Nullable changed from false to true
        • Modified property: new_plan_uuid
          • Nullable changed from false to true
        • Modified property: old_plan_name
          • Nullable changed from false to true
        • Modified property: old_plan_uuid
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by_full_name
          • Nullable changed from false to true
        • Modified property: provider_reviewed_by_username
          • Nullable changed from false to true

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: consumer_reviewed_by
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: consumer_reviewed_by_username
              • Nullable changed from false to true
            • Modified property: new_plan_name
              • Nullable changed from false to true
            • Modified property: new_plan_uuid
              • Nullable changed from false to true
            • Modified property: old_plan_name
              • Nullable changed from false to true
            • Modified property: old_plan_uuid
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_full_name
              • Nullable changed from false to true
            • Modified property: provider_reviewed_by_username
              • Nullable changed from false to true

POST /api/proposal-proposals/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/proposal-proposals/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

POST /api/proposal-protected-calls/{uuid}/add_user/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/proposal-protected-calls/{uuid}/update_user/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/rancher-apps/

  • New query param: can_manage

GET /api/rancher-catalogs/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: scope_type
          • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RancherCatalogScopeType
          • Schemas deleted: #/components/schemas/ScopeTypeEnum

POST /api/rancher-catalogs/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RancherCatalogScopeType
          • Schemas deleted: #/components/schemas/ScopeTypeEnum

GET /api/rancher-catalogs/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RancherCatalogScopeType
          • Schemas deleted: #/components/schemas/ScopeTypeEnum

PATCH /api/rancher-catalogs/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RancherCatalogScopeType
          • Schemas deleted: #/components/schemas/ScopeTypeEnum

PUT /api/rancher-catalogs/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RancherCatalogScopeType
          • Schemas deleted: #/components/schemas/ScopeTypeEnum

POST /api/rancher-catalogs/{uuid}/refresh/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RancherCatalogScopeType
          • Schemas deleted: #/components/schemas/ScopeTypeEnum

GET /api/rancher-clusters/

  • New query param: can_manage
  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [node_command]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: node_command

POST /api/rancher-clusters/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: node_command

GET /api/rancher-clusters/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [node_command]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: node_command

PATCH /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: node_command

PUT /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: node_command

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: node_command

GET /api/rancher-clusters/{uuid}/kubeconfig_file/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [node_command]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: node_command

GET /api/rancher-ingresses/

  • New query param: can_manage

GET /api/rancher-nodes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • Deleted required property: get_node_command
        • Properties changed
        • Deleted property: get_node_command

GET /api/rancher-nodes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: get_node_command
      • Properties changed
        • Deleted property: get_node_command

GET /api/rancher-services/

  • New query param: can_manage

GET /api/rancher-users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: cluster_roles
          • Items changed
          • Properties changed
            • Modified property: role
            • Format changed from '' to 'uri'
            • Deleted enum values: [owner member]
        • Modified property: project_roles
          • Items changed
          • Properties changed
            • Modified property: role
            • Format changed from '' to 'uri'
            • MaxLength changed from 255 to null

GET /api/rancher-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: cluster_roles
        • Items changed
          • Properties changed
          • Modified property: role
            • Format changed from '' to 'uri'
            • Deleted enum values: [owner member]
        • Modified property: project_roles
        • Items changed
          • Properties changed
          • Modified property: role
            • Format changed from '' to 'uri'
            • MaxLength changed from 255 to null

GET /api/slurm-allocations/

  • New query param: can_manage

GET /api/vmware-disks/

  • New query param: can_manage

GET /api/vmware-ports/

  • New query param: can_manage

GET /api/vmware-virtual-machine/

  • New query param: can_manage

OpenAPI schema diff - 7.5.0

For version 7.5.0

New Endpoints: 2

GET /api/openstack-network-rbac-policies/
GET /api/openstack-network-rbac-policies/{uuid}/

Deleted Endpoints: None

Modified Endpoints: 34

GET /api/customers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_unallocated_credit]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: customer_unallocated_credit

POST /api/customers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_unallocated_credit

GET /api/customers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_unallocated_credit]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_unallocated_credit

PATCH /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_unallocated_credit

PUT /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_unallocated_credit

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • Deleted required property: state

POST /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

PATCH /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

PUT /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: state

GET /api/openstack-networks/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: rbac_policies
          • Items changed
          • Properties changed
            • New property: network_name
            • New property: target_tenant_name
            • New property: url

GET /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • New property: network_name
          • New property: target_tenant_name
          • New property: url

PATCH /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • New property: network_name
          • New property: target_tenant_name
          • New property: url

PUT /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • New property: network_name
          • New property: target_tenant_name
          • New property: url

POST /api/openstack-networks/{uuid}/rbac_policy_create/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: network_name
        • New property: target_tenant_name
        • New property: url

POST /api/openstack-tenants/{uuid}/create_network/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • New property: network_name
          • New property: target_tenant_name
          • New property: url

GET /api/proposal-proposals/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: project_name
        • Properties changed
        • New property: project_name

POST /api/proposal-proposals/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: project_name
      • Properties changed
        • New property: project_name

GET /api/proposal-proposals/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: project_name
      • Properties changed
        • New property: project_name

GET /api/proposal-protected-calls/{uuid}/rounds/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: proposals
          • Items changed
          • Properties changed
            • Modified property: reviews
            • Items changed
              • Required changed
              • New required property: proposal_uuid
              • Properties changed
              • New property: proposal_uuid

POST /api/proposal-protected-calls/{uuid}/rounds/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Items changed
            • Required changed
              • New required property: proposal_uuid
            • Properties changed
              • New property: proposal_uuid

GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Items changed
            • Required changed
              • New required property: proposal_uuid
            • Properties changed
              • New property: proposal_uuid

PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Items changed
            • Required changed
              • New required property: proposal_uuid
            • Properties changed
              • New property: proposal_uuid

PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Items changed
            • Required changed
              • New required property: proposal_uuid
            • Properties changed
              • New property: proposal_uuid

GET /api/proposal-reviews/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: proposal_uuid
        • Properties changed
        • New property: proposal_uuid

POST /api/proposal-reviews/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: proposal_uuid
      • Properties changed
        • New property: proposal_uuid

GET /api/proposal-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: proposal_uuid
      • Properties changed
        • New property: proposal_uuid

PATCH /api/proposal-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: proposal_uuid
      • Properties changed
        • New property: proposal_uuid

PUT /api/proposal-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: proposal_uuid
      • Properties changed
        • New property: proposal_uuid

OpenAPI schema diff - 7.5.1

For version 7.5.1

New Endpoints: 21

GET /api/marketplace-customer-service-accounts/
POST /api/marketplace-customer-service-accounts/
DELETE /api/marketplace-customer-service-accounts/{uuid}/
GET /api/marketplace-customer-service-accounts/{uuid}/
PATCH /api/marketplace-customer-service-accounts/{uuid}/
PUT /api/marketplace-customer-service-accounts/{uuid}/
POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/
GET /api/marketplace-project-service-accounts/
POST /api/marketplace-project-service-accounts/
DELETE /api/marketplace-project-service-accounts/{uuid}/
GET /api/marketplace-project-service-accounts/{uuid}/
PATCH /api/marketplace-project-service-accounts/{uuid}/
PUT /api/marketplace-project-service-accounts/{uuid}/
POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/
POST /api/openstack-ports/
PATCH /api/openstack-ports/{uuid}/
PUT /api/openstack-ports/{uuid}/
POST /api/openstack-ports/{uuid}/disable_port/
POST /api/openstack-ports/{uuid}/disable_port_security/
POST /api/openstack-ports/{uuid}/enable_port/
POST /api/openstack-ports/{uuid}/enable_port_security/

Deleted Endpoints: 2

POST /api/openstack-networks/{uuid}/create_port/
GET /api/rancher-clusters/{uuid}/kubeconfig_file/

Modified Endpoints: 43

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_port_updated service_account_created service_account_deleted service_account_updated]

GET /api/keycloak-user-group-memberships/

  • New query param: state

GET /api/marketplace-provider-offerings/

  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

GET /api/marketplace-provider-offerings/groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

GET /api/marketplace-provider-offerings/{uuid}/component_stats/

  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid

GET /api/marketplace-provider-offerings/{uuid}/costs/

  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid

GET /api/marketplace-provider-offerings/{uuid}/customers/

  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: secret_options
        • Properties changed
        • New property: argocd_k8s_kubeconfig
        • New property: argocd_k8s_namespace
        • New property: keycloak_password
        • New property: keycloak_realm
        • New property: keycloak_ssl_verify
        • New property: keycloak_sync_frequency
        • New property: keycloak_url
        • New property: keycloak_user_realm
        • New property: keycloak_username
        • New property: vault_host
        • New property: vault_port
        • New property: vault_tls_verify
        • New property: vault_token

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

GET /api/marketplace-public-offerings/

  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
        • Properties changed
        • New property: description
        • Modified property: state
          • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
          • Type changed from 'string' to ''
        • Modified property: type
          • Description changed from '' to 'Type of the robot account.'

POST /api/marketplace-robot-accounts/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: description
      • Modified property: type
        • Description changed from '' to 'Type of the robot account.'
      • Modified property: users
        • Description changed from '' to 'Users who have access to this robot account.'
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'
        • Modified property: users
        • Description changed from '' to 'Users who have access to this robot account.'

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'

PATCH /api/marketplace-robot-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: description
      • New property: resource
      • Modified property: type
        • Description changed from '' to 'Type of the robot account.'
      • Modified property: users
        • Description changed from '' to 'Users who have access to this robot account.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'
        • Modified property: users
        • Description changed from '' to 'Users who have access to this robot account.'

PUT /api/marketplace-robot-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: description
      • Modified property: type
        • Description changed from '' to 'Type of the robot account.'
      • Modified property: users
        • Description changed from '' to 'Users who have access to this robot account.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'
        • Modified property: users
        • Description changed from '' to 'Users who have access to this robot account.'

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: error_message
        • Deleted required property: error_traceback
      • Properties changed
        • New property: description
        • Modified property: state
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/RobotAccountStates
        • Type changed from 'string' to ''
        • Modified property: type
        • Description changed from '' to 'Type of the robot account.'

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: argocd_k8s_kubeconfig
            • New property: argocd_k8s_namespace
            • New property: keycloak_password
            • New property: keycloak_realm
            • New property: keycloak_ssl_verify
            • New property: keycloak_sync_frequency
            • New property: keycloak_url
            • New property: keycloak_user_realm
            • New property: keycloak_username
            • New property: vault_host
            • New property: vault_port
            • New property: vault_tls_verify
            • New property: vault_token

GET /api/openstack-ports/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [admin_state_up]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: admin_state_up
        • Modified property: allowed_address_pairs
          • ReadOnly changed from true to false
        • Modified property: port_security_enabled
          • ReadOnly changed from true to false
        • Modified property: security_groups
          • ReadOnly changed from true to false

GET /api/openstack-ports/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [admin_state_up]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: admin_state_up
        • Modified property: allowed_address_pairs
        • ReadOnly changed from true to false
        • Modified property: port_security_enabled
        • ReadOnly changed from true to false
        • Modified property: security_groups
        • ReadOnly changed from true to false

GET /api/rancher-apps/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: external_url
          • Nullable changed from false to true

POST /api/rancher-apps/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: external_url
        • Nullable changed from false to true

GET /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: external_url
        • Nullable changed from false to true

PATCH /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: external_url
        • Nullable changed from false to true

PUT /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: external_url
        • Nullable changed from false to true

GET /api/rancher-role-templates/

  • New query param: name
  • New query param: scope_type
  • New query param: settings_uuid

OpenAPI schema diff - 7.5.2

For version 7.5.2

New Endpoints: 1

POST /api/openstack-ports/{uuid}/update_port_ip/

Deleted Endpoints: None

Modified Endpoints: 82

GET /api/booking-resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

GET /api/booking-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/customer-permissions-reviews/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: reviewer_full_name
          • Nullable changed from false to true
        • Modified property: reviewer_uuid
          • Nullable changed from false to true

GET /api/customer-permissions-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: reviewer_full_name
        • Nullable changed from false to true
        • Modified property: reviewer_uuid
        • Nullable changed from false to true

GET /api/keycloak-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: scope_name
          • Nullable changed from false to true

GET /api/keycloak-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_name
        • Nullable changed from false to true

GET /api/marketplace-orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

POST /api/marketplace-orders/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-orders/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

GET /api/marketplace-provider-offerings/groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: type_name
          • Nullable changed from false to true
        • Modified property: type_uuid
          • Nullable changed from false to true

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: secret_options
        • Properties changed
        • New property: base_image_name
        • New property: dns_nameservers

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

GET /api/marketplace-provider-resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

GET /api/marketplace-provider-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-provider-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/set_as_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

GET /api/marketplace-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_description
            • Nullable changed from false to true
            • Modified property: plan_name
            • Nullable changed from false to true
            • Modified property: plan_unit
            • Nullable changed from false to true
            • Modified property: plan_uuid
            • Nullable changed from false to true
        • Modified property: plan_description
        • Nullable changed from false to true
        • Modified property: plan_name
        • Nullable changed from false to true
        • Modified property: plan_unit
        • Nullable changed from false to true
        • Modified property: plan_uuid
        • Nullable changed from false to true

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: base_image_name
            • New property: dns_nameservers

GET /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: created_by_full_name
          • Nullable changed from false to true
        • Modified property: created_by_username
          • Nullable changed from false to true

GET /api/marketplace-service-providers/{service_provider_uuid}/projects/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: type_name
          • Nullable changed from false to true
        • Modified property: type_uuid
          • Nullable changed from false to true

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance_floating_ips
          • Items changed
          • Properties changed
            • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: instance_ports
          • Items changed
          • Properties changed
            • Modified property: subnet_cidr
            • Nullable changed from false to true
            • Modified property: subnet_description
            • Nullable changed from false to true
            • Modified property: subnet_name
            • Nullable changed from false to true
            • Modified property: subnet_uuid
            • Nullable changed from false to true
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: floating_ips
            • Items changed
              • Properties changed
              • Modified property: port_mac_address
                • Nullable changed from false to true
            • Modified property: ports
            • Items changed
              • Properties changed
              • Modified property: subnet_cidr
                • Nullable changed from false to true
              • Modified property: subnet_description
                • Nullable changed from false to true
              • Modified property: subnet_name
                • Nullable changed from false to true
              • Modified property: subnet_uuid
                • Nullable changed from false to true

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: floating_ips
            • Items changed
            • Properties changed
              • Modified property: port_mac_address
              • Nullable changed from false to true
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: subnet_cidr
              • Nullable changed from false to true
              • Modified property: subnet_description
              • Nullable changed from false to true
              • Modified property: subnet_name
              • Nullable changed from false to true
              • Modified property: subnet_uuid
              • Nullable changed from false to true

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: floating_ips
            • Items changed
            • Properties changed
              • Modified property: port_mac_address
              • Nullable changed from false to true
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: subnet_cidr
              • Nullable changed from false to true
              • Modified property: subnet_description
              • Nullable changed from false to true
              • Modified property: subnet_name
              • Nullable changed from false to true
              • Modified property: subnet_uuid
              • Nullable changed from false to true

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: floating_ips
            • Items changed
            • Properties changed
              • Modified property: port_mac_address
              • Nullable changed from false to true
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: subnet_cidr
              • Nullable changed from false to true
              • Modified property: subnet_description
              • Nullable changed from false to true
              • Modified property: subnet_name
              • Nullable changed from false to true
              • Modified property: subnet_uuid
              • Nullable changed from false to true

POST /api/openstack-backups/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: floating_ips
          • Items changed
          • Properties changed
            • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: ports
          • Items changed
          • Properties changed
            • Modified property: subnet_cidr
            • Nullable changed from false to true
            • Modified property: subnet_description
            • Nullable changed from false to true
            • Modified property: subnet_name
            • Nullable changed from false to true
            • Modified property: subnet_uuid
            • Nullable changed from false to true

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: port_mac_address
            • Nullable changed from false to true
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: subnet_cidr
            • Nullable changed from false to true
          • Modified property: subnet_description
            • Nullable changed from false to true
          • Modified property: subnet_name
            • Nullable changed from false to true
          • Modified property: subnet_uuid
            • Nullable changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: floating_ips
            • Items changed
            • Properties changed
              • Modified property: port_mac_address
              • Nullable changed from false to true
          • Modified property: ports
            • Items changed
            • Properties changed
              • Modified property: subnet_cidr
              • Nullable changed from false to true
              • Modified property: subnet_description
              • Nullable changed from false to true
              • Modified property: subnet_name
              • Nullable changed from false to true
              • Modified property: subnet_uuid
              • Nullable changed from false to true

GET /api/openstack-instances/{uuid}/floating_ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: port_mac_address
          • Nullable changed from false to true

GET /api/openstack-instances/{uuid}/ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: subnet_cidr
          • Nullable changed from false to true
        • Modified property: subnet_description
          • Nullable changed from false to true
        • Modified property: subnet_name
          • Nullable changed from false to true
        • Modified property: subnet_uuid
          • Nullable changed from false to true

GET /api/projects/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: type_name
          • Nullable changed from false to true
        • Modified property: type_uuid
          • Nullable changed from false to true

POST /api/projects/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: type_name
        • Nullable changed from false to true
        • Modified property: type_uuid
        • Nullable changed from false to true

GET /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: type_name
        • Nullable changed from false to true
        • Modified property: type_uuid
        • Nullable changed from false to true

PATCH /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: type_name
        • Nullable changed from false to true
        • Modified property: type_uuid
        • Nullable changed from false to true

PUT /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: type_name
        • Nullable changed from false to true
        • Modified property: type_uuid
        • Nullable changed from false to true

POST /api/projects/{uuid}/move_project/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: type_name
        • Nullable changed from false to true
        • Modified property: type_uuid
        • Nullable changed from false to true

GET /api/promotions-campaigns/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_description
              • Nullable changed from false to true
            • Modified property: plan_name
              • Nullable changed from false to true
            • Modified property: plan_unit
              • Nullable changed from false to true
            • Modified property: plan_uuid
              • Nullable changed from false to true
        • Modified property: plan_description
          • Nullable changed from false to true
        • Modified property: plan_name
          • Nullable changed from false to true
        • Modified property: plan_unit
          • Nullable changed from false to true
        • Modified property: plan_uuid
          • Nullable changed from false to true

GET /api/proposal-reviews/

  • New query param: proposal_name

GET /api/rancher-cluster-templates/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: nodes
          • Items changed
          • Required changed
            • New required property: role
            • Deleted required property: roles
          • Properties changed
            • New property: role
            • Deleted property: roles

GET /api/rancher-cluster-templates/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: nodes
        • Items changed
          • Required changed
          • New required property: role
          • Deleted required property: roles
          • Properties changed
          • New property: role
          • Deleted property: roles

GET /api/rancher-clusters/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: nodes
          • Items changed
          • Properties changed
            • New property: role
            • Deleted property: controlplane_role
            • Deleted property: etcd_role
            • Deleted property: worker_role

POST /api/rancher-clusters/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: nodes
        • Items changed
        • Required changed
          • New required property: role
          • Deleted required property: roles
        • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: roles
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: nodes
        • Items changed
          • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: etcd_role
          • Deleted property: worker_role

GET /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: nodes
        • Items changed
          • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: etcd_role
          • Deleted property: worker_role

PATCH /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: nodes
        • Items changed
          • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: etcd_role
          • Deleted property: worker_role

PUT /api/rancher-clusters/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: nodes
        • Items changed
        • Required changed
          • New required property: role
          • Deleted required property: roles
        • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: roles
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: nodes
        • Items changed
          • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: etcd_role
          • Deleted property: worker_role

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: nodes
        • Items changed
        • Required changed
          • New required property: role
          • Deleted required property: roles
        • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: roles
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: nodes
        • Items changed
          • Properties changed
          • New property: role
          • Deleted property: controlplane_role
          • Deleted property: etcd_role
          • Deleted property: worker_role

GET /api/rancher-nodes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: role
        • Properties changed
        • New property: role
        • Deleted property: controlplane_role
        • Deleted property: etcd_role
        • Deleted property: worker_role

POST /api/rancher-nodes/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: role
      • Deleted required property: roles
      • Properties changed
      • New property: role
      • Deleted property: roles
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: role
      • Properties changed
        • New property: role

GET /api/rancher-nodes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: role
      • Properties changed
        • New property: role
        • Deleted property: controlplane_role
        • Deleted property: etcd_role
        • Deleted property: worker_role

GET /api/rancher-template-versions/{template_uuid}/{version}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: questions
        • Items changed
          • Properties changed
          • New property: validate_
          • Deleted property: validate
          • Modified property: subquestions
            • Items changed
            • Properties changed
              • New property: validate_
              • Deleted property: validate

GET /api/service-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: customer_name
          • Nullable changed from false to true

GET /api/service-settings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: customer_name
        • Nullable changed from false to true

GET /api/slurm-jobs/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: user_username
          • Nullable changed from false to true
        • Modified property: user_uuid
          • Nullable changed from false to true

POST /api/slurm-jobs/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: user_username
        • Nullable changed from false to true
        • Modified property: user_uuid
        • Nullable changed from false to true

GET /api/slurm-jobs/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: user_username
        • Nullable changed from false to true
        • Modified property: user_uuid
        • Nullable changed from false to true

PATCH /api/slurm-jobs/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: user_username
        • Nullable changed from false to true
        • Modified property: user_uuid
        • Nullable changed from false to true

PUT /api/slurm-jobs/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: user_username
        • Nullable changed from false to true
        • Modified property: user_uuid
        • Nullable changed from false to true

GET /api/support-issues/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: assignee_name
          • Nullable changed from false to true
        • Modified property: assignee_uuid
          • Nullable changed from false to true
        • Modified property: caller_full_name
          • Nullable changed from false to true
        • Modified property: caller_uuid
          • Nullable changed from false to true
        • Modified property: customer_name
          • Nullable changed from false to true
        • Modified property: customer_uuid
          • Nullable changed from false to true
        • Modified property: project_name
          • Nullable changed from false to true
        • Modified property: project_uuid
          • Nullable changed from false to true
        • Modified property: reporter_name
          • Nullable changed from false to true
        • Modified property: reporter_uuid
          • Nullable changed from false to true

POST /api/support-issues/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: assignee_name
        • Nullable changed from false to true
        • Modified property: assignee_uuid
        • Nullable changed from false to true
        • Modified property: caller_full_name
        • Nullable changed from false to true
        • Modified property: caller_uuid
        • Nullable changed from false to true
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: reporter_name
        • Nullable changed from false to true
        • Modified property: reporter_uuid
        • Nullable changed from false to true

GET /api/support-issues/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: assignee_name
        • Nullable changed from false to true
        • Modified property: assignee_uuid
        • Nullable changed from false to true
        • Modified property: caller_full_name
        • Nullable changed from false to true
        • Modified property: caller_uuid
        • Nullable changed from false to true
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: reporter_name
        • Nullable changed from false to true
        • Modified property: reporter_uuid
        • Nullable changed from false to true

PATCH /api/support-issues/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: assignee_name
        • Nullable changed from false to true
        • Modified property: assignee_uuid
        • Nullable changed from false to true
        • Modified property: caller_full_name
        • Nullable changed from false to true
        • Modified property: caller_uuid
        • Nullable changed from false to true
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: reporter_name
        • Nullable changed from false to true
        • Modified property: reporter_uuid
        • Nullable changed from false to true

PUT /api/support-issues/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: assignee_name
        • Nullable changed from false to true
        • Modified property: assignee_uuid
        • Nullable changed from false to true
        • Modified property: caller_full_name
        • Nullable changed from false to true
        • Modified property: caller_uuid
        • Nullable changed from false to true
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: reporter_name
        • Nullable changed from false to true
        • Modified property: reporter_uuid
        • Nullable changed from false to true

POST /api/support-issues/{uuid}/sync/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: assignee_name
        • Nullable changed from false to true
        • Modified property: assignee_uuid
        • Nullable changed from false to true
        • Modified property: caller_full_name
        • Nullable changed from false to true
        • Modified property: caller_uuid
        • Nullable changed from false to true
        • Modified property: customer_name
        • Nullable changed from false to true
        • Modified property: customer_uuid
        • Nullable changed from false to true
        • Modified property: project_name
        • Nullable changed from false to true
        • Modified property: project_uuid
        • Nullable changed from false to true
        • Modified property: reporter_name
        • Nullable changed from false to true
        • Modified property: reporter_uuid
        • Nullable changed from false to true

OpenAPI schema diff - 7.5.3

For version 7.5.3

New Endpoints: None

Deleted Endpoints: None

Modified Endpoints: 188

GET /api/aws-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/aws-instances/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/aws-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/aws-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/aws-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/aws-volumes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/aws-volumes/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/aws-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/aws-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/aws-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-public-ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/azure-public-ips/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-public-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/azure-public-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/azure-public-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-resource-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/azure-resource-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-sql-databases/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/azure-sql-databases/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-sql-databases/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/azure-sql-databases/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/azure-sql-databases/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-sql-servers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/azure-sql-servers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-sql-servers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/azure-sql-servers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/azure-sql-servers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-virtualmachines/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/azure-virtualmachines/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/azure-virtualmachines/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/azure-virtualmachines/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/azure-virtualmachines/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/booking-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/booking-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/digitalocean-droplets/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/digitalocean-droplets/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/digitalocean-droplets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/digitalocean-droplets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/digitalocean-droplets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/keycloak-user-group-memberships/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: group_scope_name
        • Properties changed
        • New property: group_scope_name

POST /api/keycloak-user-group-memberships/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: group_scope_name
      • Properties changed
        • New property: group_scope_name

GET /api/keycloak-user-group-memberships/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: group_scope_name
      • Properties changed
        • New property: group_scope_name

PATCH /api/keycloak-user-group-memberships/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: group_scope_name
      • Properties changed
        • New property: group_scope_name

PUT /api/keycloak-user-group-memberships/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: group_scope_name
      • Properties changed
        • New property: group_scope_name

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-provider-offerings/groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plugin_options
        • Properties changed
        • New property: managed_rancher_load_balancer_cloud_init_template
        • New property: managed_rancher_load_balancer_data_volume_size_gb
        • New property: managed_rancher_load_balancer_data_volume_type_name
        • New property: managed_rancher_load_balancer_flavor_name
        • New property: managed_rancher_load_balancer_system_volume_size_gb
        • New property: managed_rancher_load_balancer_system_volume_type_name
        • New property: managed_rancher_server_data_volume_size_gb
        • New property: managed_rancher_server_data_volume_type_name
        • New property: managed_rancher_worker_system_volume_size_gb
        • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-public-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-public-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offering_plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
            • New property: managed_rancher_load_balancer_data_volume_size_gb
            • New property: managed_rancher_load_balancer_data_volume_type_name
            • New property: managed_rancher_load_balancer_flavor_name
            • New property: managed_rancher_load_balancer_system_volume_size_gb
            • New property: managed_rancher_load_balancer_system_volume_type_name
            • New property: managed_rancher_server_data_volume_size_gb
            • New property: managed_rancher_server_data_volume_type_name
            • New property: managed_rancher_worker_system_volume_size_gb
            • New property: managed_rancher_worker_system_volume_type_name

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-backups/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true
        • Modified property: server_group
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/OpenStackNestedServerGroup
        • Type changed from 'object' to ''
        • Nullable changed from false to true
        • Properties changed
          • Deleted property: name
          • Deleted property: policy
          • Deleted property: state
          • Deleted property: url

GET /api/openstack-floating-ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-floating-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true
        • Modified property: server_group
          • Property 'AllOf' changed
          • Schemas added: #/components/schemas/OpenStackNestedServerGroup
          • Type changed from 'object' to ''
          • Nullable changed from false to true
          • Properties changed
          • Deleted property: name
          • Deleted property: policy
          • Deleted property: state
          • Deleted property: url

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true
        • Modified property: server_group
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/OpenStackNestedServerGroup
        • Type changed from 'object' to ''
        • Nullable changed from false to true
        • Properties changed
          • Deleted property: name
          • Deleted property: policy
          • Deleted property: state
          • Deleted property: url

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true
        • Modified property: server_group
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/OpenStackNestedServerGroup
        • Type changed from 'object' to ''
        • Nullable changed from false to true
        • Properties changed
          • Deleted property: name
          • Deleted property: policy
          • Deleted property: state
          • Deleted property: url

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true
        • Modified property: server_group
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/OpenStackNestedServerGroup
        • Type changed from 'object' to ''
        • Nullable changed from false to true
        • Properties changed
          • Deleted property: name
          • Deleted property: policy
          • Deleted property: state
          • Deleted property: url

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-networks/

  • New query param: direct_only
  • New query param: rbac_only
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-networks/{uuid}/create_subnet/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-ports/

  • New query param: query
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [status]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: status
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/openstack-ports/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: status
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-ports/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [status]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: status
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: status
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: status
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-ports/{uuid}/disable_port/

  • Request body changed

POST /api/openstack-ports/{uuid}/disable_port_security/

  • Request body changed

POST /api/openstack-ports/{uuid}/enable_port/

  • Request body changed

POST /api/openstack-ports/{uuid}/enable_port_security/

  • Request body changed

GET /api/openstack-routers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-routers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-security-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-security-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-server-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/openstack-server-groups/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-snapshots/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-snapshots/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-subnets/

  • New query param: direct_only
  • New query param: rbac_only
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-tenants/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/openstack-tenants/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_floating_ip/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_network/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_server_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/pull_security_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/pull_server_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/openstack-volumes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/openstack-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/openstack-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/openstack-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/openstack-volumes/{uuid}/snapshot/

  • Responses changed
  • New response: 201
  • Deleted response: 200

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: ENABLE_RESOURCE_END_DATE

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: ENABLE_RESOURCE_END_DATE

GET /api/proposal-proposals/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: supporting_documentation
          • Items changed
          • Required changed
            • New required property: file_size
          • Properties changed
            • New property: file_size

POST /api/proposal-proposals/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: supporting_documentation
        • Items changed
          • Required changed
          • New required property: file_size
          • Properties changed
          • New property: file_size

GET /api/proposal-proposals/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: supporting_documentation
        • Items changed
          • Required changed
          • New required property: file_size
          • Properties changed
          • New property: file_size

GET /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: documents
          • Items changed
          • Properties changed
            • New property: file_size

POST /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: documents
        • Items changed
          • Properties changed
          • New property: file_size

GET /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: documents
        • Items changed
          • Properties changed
          • New property: file_size

PATCH /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: documents
        • Items changed
          • Properties changed
          • New property: file_size

PUT /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: documents
        • Items changed
          • Properties changed
          • New property: file_size

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: documents
        • Items changed
          • Properties changed
          • New property: file_size

GET /api/proposal-public-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: documents
          • Items changed
          • Properties changed
            • New property: file_size

GET /api/proposal-public-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: documents
        • Items changed
          • Properties changed
          • New property: file_size

GET /api/rancher-apps/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/rancher-apps/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-clusters/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [vm_project]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: vm_project
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/rancher-clusters/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: tenant
      • Properties changed
      • New property: vm_project
      • Modified property: nodes
        • Items changed
        • Properties changed
          • New property: tenant
          • Modified property: data_volumes
          • Items changed
            • Properties changed
            • New property: filesystem
            • Modified property: mount_point
              • New enum values: [/opt/rke2_storage]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: vm_project
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-clusters/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [vm_project]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: vm_project
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/rancher-clusters/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: vm_project
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: vm_project
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/rancher-clusters/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: tenant
      • Properties changed
      • New property: vm_project
      • Modified property: nodes
        • Items changed
        • Properties changed
          • New property: tenant
          • Modified property: data_volumes
          • Items changed
            • Properties changed
            • New property: filesystem
            • Modified property: mount_point
              • New enum values: [/opt/rke2_storage]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: vm_project
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: tenant
      • Properties changed
      • New property: vm_project
      • Modified property: nodes
        • Items changed
        • Properties changed
          • New property: tenant
          • Modified property: data_volumes
          • Items changed
            • Properties changed
            • New property: filesystem
            • Modified property: mount_point
              • New enum values: [/opt/rke2_storage]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: vm_project
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-ingresses/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/rancher-ingresses/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-ingresses/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/rancher-ingresses/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/rancher-ingresses/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-ingresses/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/rancher-ingresses/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/rancher-nodes/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: tenant
      • Modified property: data_volumes
        • Items changed
        • Properties changed
          • New property: filesystem
          • Modified property: mount_point
          • New enum values: [/opt/rke2_storage]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: uuid
      • Properties changed
        • New property: uuid

GET /api/rancher-services/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/rancher-services/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-services/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/rancher-services/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/rancher-services/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/rancher-services/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/rancher-services/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/slurm-allocations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/slurm-allocations/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/slurm-allocations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/slurm-allocations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/slurm-allocations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/support-issues/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: feedback
          • Nullable changed from false to true

POST /api/support-issues/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: feedback
        • Nullable changed from false to true

GET /api/support-issues/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: feedback
        • Nullable changed from false to true

PATCH /api/support-issues/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: feedback
        • Nullable changed from false to true

PUT /api/support-issues/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: feedback
        • Nullable changed from false to true

POST /api/support-issues/{uuid}/sync/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: feedback
        • Nullable changed from false to true

GET /api/vmware-disks/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/vmware-disks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/vmware-ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

GET /api/vmware-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/vmware-virtual-machine/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_limit_based
          • Nullable changed from false to true
        • Modified property: is_usage_based
          • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_offering_name
          • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
          • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
          • Nullable changed from false to true
        • Modified property: marketplace_resource_state
          • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
          • Nullable changed from false to true

POST /api/vmware-virtual-machine/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

GET /api/vmware-virtual-machine/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PATCH /api/vmware-virtual-machine/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

PUT /api/vmware-virtual-machine/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/vmware-virtual-machine/{uuid}/create_disk/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

POST /api/vmware-virtual-machine/{uuid}/create_port/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_limit_based
        • Nullable changed from false to true
        • Modified property: is_usage_based
        • Nullable changed from false to true
        • Modified property: marketplace_category_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_offering_name
        • Nullable changed from false to true
        • Modified property: marketplace_offering_plugin_options
        • Nullable changed from false to true
        • Modified property: marketplace_offering_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_plan_uuid
        • Nullable changed from false to true
        • Modified property: marketplace_resource_state
        • Nullable changed from false to true
        • Modified property: marketplace_resource_uuid
        • Nullable changed from false to true

OpenAPI schema diff - 7.5.4

For version 7.5.4

New Endpoints: None

Deleted Endpoints: None

Modified Endpoints: 14

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: node_disk_driver

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

GET /api/marketplace-provider-offerings/groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: secret_options
        • Properties changed
        • New property: node_disk_driver

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: node_disk_driver

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: node_disk_driver

GET /api/openstack-migrations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: error_message
        • New property: error_traceback

GET /api/openstack-migrations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: error_message
        • New property: error_traceback

PATCH /api/openstack-migrations/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: error_message
      • New property: error_traceback
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: error_message
        • New property: error_traceback

PUT /api/openstack-migrations/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: error_message
      • New property: error_traceback
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: error_message
        • New property: error_traceback

OpenAPI schema diff - 7.5.5

For version 7.5.5

New Endpoints: 7

POST /api/openstack-routers/{uuid}/add_router_interface/
POST /api/openstack-routers/{uuid}/remove_router_interface/
GET /api/projects/{uuid}/other_users/
GET /api/rancher-cluster-security-groups/
GET /api/rancher-cluster-security-groups/{uuid}/
PATCH /api/rancher-cluster-security-groups/{uuid}/
PUT /api/rancher-cluster-security-groups/{uuid}/

Deleted Endpoints: None

Modified Endpoints: 40

GET /api/booking-resources/

  • New query param: has_terminate_date

PATCH /api/invoice-items/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: unit_price
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: unit_price

PUT /api/invoice-items/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: unit_price
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: unit_price

GET /api/marketplace-component-user-usages/

  • New query param: billing_period_month
  • New query param: billing_period_year
  • New query param: o
  • New query param: username

GET /api/marketplace-customer-service-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
        • Properties changed
        • New property: customer_name
        • New property: customer_uuid

POST /api/marketplace-customer-service-accounts/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid

GET /api/marketplace-customer-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid

PATCH /api/marketplace-customer-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid

PUT /api/marketplace-customer-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid

POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid

GET /api/marketplace-project-service-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: customer_abbreviation
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: project_name
        • New required property: project_uuid
        • Properties changed
        • New property: customer_abbreviation
        • New property: customer_name
        • New property: customer_uuid
        • New property: project_name
        • New property: project_uuid

POST /api/marketplace-project-service-accounts/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_abbreviation
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: project_name
        • New required property: project_uuid
      • Properties changed
        • New property: customer_abbreviation
        • New property: customer_name
        • New property: customer_uuid
        • New property: project_name
        • New property: project_uuid

GET /api/marketplace-project-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_abbreviation
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: project_name
        • New required property: project_uuid
      • Properties changed
        • New property: customer_abbreviation
        • New property: customer_name
        • New property: customer_uuid
        • New property: project_name
        • New property: project_uuid

PATCH /api/marketplace-project-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_abbreviation
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: project_name
        • New required property: project_uuid
      • Properties changed
        • New property: customer_abbreviation
        • New property: customer_name
        • New property: customer_uuid
        • New property: project_name
        • New property: project_uuid

PUT /api/marketplace-project-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_abbreviation
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: project_name
        • New required property: project_uuid
      • Properties changed
        • New property: customer_abbreviation
        • New property: customer_name
        • New property: customer_uuid
        • New property: project_name
        • New property: project_uuid

POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_abbreviation
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: project_name
        • New required property: project_uuid
      • Properties changed
        • New property: customer_abbreviation
        • New property: customer_name
        • New property: customer_uuid
        • New property: project_name
        • New property: project_uuid

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

GET /api/marketplace-provider-offerings/groups/

  • OperationID changed from 'marketplace_provider_offerings_groups_retrieve' to 'marketplace_provider_offerings_groups_list'
  • New query param: accessible_via_calls
  • New query param: allowed_customer_uuid
  • New query param: attributes
  • New query param: billable
  • New query param: category_group_uuid
  • New query param: category_uuid
  • New query param: created
  • New query param: customer
  • New query param: customer_uuid
  • New query param: description
  • New query param: keyword
  • New query param: modified
  • New query param: name
  • New query param: name_exact
  • New query param: o
  • New query param: organization_group_uuid
  • New query param: page
  • New query param: page_size
  • New query param: parent_uuid
  • New query param: project_uuid
  • New query param: resource_customer_uuid
  • New query param: resource_project_uuid
  • New query param: scope_uuid
  • New query param: service_manager_uuid
  • New query param: shared
  • New query param: state
  • New query param: type
  • Deleted query param: field
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Type changed from 'object' to 'array'
      • Items changed
        • Schema added
      • Properties changed
        • Deleted property: access_url
        • Deleted property: attributes
        • Deleted property: backend_id
        • Deleted property: backend_metadata
        • Deleted property: billable
        • Deleted property: category
        • Deleted property: category_title
        • Deleted property: category_uuid
        • Deleted property: citation_count
        • Deleted property: components
        • Deleted property: country
        • Deleted property: created
        • Deleted property: customer
        • Deleted property: customer_name
        • Deleted property: customer_uuid
        • Deleted property: datacite_doi
        • Deleted property: description
        • Deleted property: endpoints
        • Deleted property: files
        • Deleted property: full_description
        • Deleted property: getting_started
        • Deleted property: google_calendar_is_public
        • Deleted property: google_calendar_link
        • Deleted property: image
        • Deleted property: integration_guide
        • Deleted property: integration_status
        • Deleted property: latitude
        • Deleted property: longitude
        • Deleted property: name
        • Deleted property: options
        • Deleted property: order_count
        • Deleted property: organization_groups
        • Deleted property: parent_description
        • Deleted property: parent_name
        • Deleted property: parent_uuid
        • Deleted property: paused_reason
        • Deleted property: plans
        • Deleted property: plugin_options
        • Deleted property: privacy_policy_link
        • Deleted property: project
        • Deleted property: project_name
        • Deleted property: project_uuid
        • Deleted property: quotas
        • Deleted property: resource_options
        • Deleted property: roles
        • Deleted property: scope
        • Deleted property: scope_error_message
        • Deleted property: scope_name
        • Deleted property: scope_state
        • Deleted property: scope_uuid
        • Deleted property: screenshots
        • Deleted property: secret_options
        • Deleted property: service_attributes
        • Deleted property: shared
        • Deleted property: slug
        • Deleted property: state
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Deleted property: thumbnail
        • Deleted property: total_cost
        • Deleted property: total_cost_estimated
        • Deleted property: total_customers
        • Deleted property: type
        • Deleted property: url
        • Deleted property: uuid
        • Deleted property: vendor_details

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: secret_options
        • Properties changed
        • New property: k8s_version
        • New property: private_registry_password
        • New property: private_registry_url
        • New property: private_registry_user

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

GET /api/marketplace-provider-resources/

  • New query param: has_terminate_date

GET /api/marketplace-resources/

  • New query param: has_terminate_date

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: k8s_version
            • New property: private_registry_password
            • New property: private_registry_url
            • New property: private_registry_user

POST /api/openstack-backups/{uuid}/restore/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: ports
        • Items changed
        • Properties changed
          • New property: port

POST /api/openstack-instances/{uuid}/update_ports/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: ports
        • Items changed
        • Properties changed
          • New property: port

GET /api/openstack-ports/

  • New query param: admin_state_up
  • New query param: backend_id
  • New query param: device_id
  • New query param: device_owner
  • New query param: has_device_owner
  • New query param: mac_address
  • New query param: status
  • Modified query param: query
  • Description changed from '' to 'Query'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: admin_state_up
          • Type changed from 'string' to 'boolean'

POST /api/openstack-ports/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Type changed from 'string' to 'boolean'

GET /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Type changed from 'string' to 'boolean'

PATCH /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Type changed from 'string' to 'boolean'

PUT /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Type changed from 'string' to 'boolean'

POST /api/rancher-clusters/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: nodes
        • Items changed
        • Properties changed
          • Modified property: data_volumes
          • Items changed
            • Required changed
            • New required property: mount_point
            • Properties changed
            • Modified property: mount_point
              • Deleted enum values: [/var/lib/docker /var/lib/etcd /opt/media01 /opt/rke2_storage]
              • MinLength changed from 0 to 1

PUT /api/rancher-clusters/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: nodes
        • Items changed
        • Properties changed
          • Modified property: data_volumes
          • Items changed
            • Required changed
            • New required property: mount_point
            • Properties changed
            • Modified property: mount_point
              • Deleted enum values: [/var/lib/docker /var/lib/etcd /opt/media01 /opt/rke2_storage]
              • MinLength changed from 0 to 1

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: nodes
        • Items changed
        • Properties changed
          • Modified property: data_volumes
          • Items changed
            • Required changed
            • New required property: mount_point
            • Properties changed
            • Modified property: mount_point
              • Deleted enum values: [/var/lib/docker /var/lib/etcd /opt/media01 /opt/rke2_storage]
              • MinLength changed from 0 to 1

POST /api/rancher-nodes/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: data_volumes
        • Items changed
        • Required changed
          • New required property: mount_point
        • Properties changed
          • Modified property: mount_point
          • Deleted enum values: [/var/lib/docker /var/lib/etcd /opt/media01 /opt/rke2_storage]
          • MinLength changed from 0 to 1

GET /api/rancher-role-templates/

  • New query param: o

OpenAPI schema diff - 7.5.6

For version 7.5.6

New Endpoints: 2

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/
GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

Deleted Endpoints: None

Modified Endpoints: 17

GET /api/marketplace-component-usages/

  • New query param: o

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance_ports
          • Items changed
          • Properties changed
            • New property: url
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: ports
            • Items changed
              • Properties changed
              • New property: url

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: url
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: url

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: url
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: url

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: url
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: url

POST /api/openstack-backups/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: url

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: ports
          • Items changed
          • Properties changed
            • New property: url

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: url

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: url

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: url

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: url
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: url

GET /api/openstack-instances/{uuid}/ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: url

GET /api/openstack-ports/

  • New query param: exclude_subnet_uuids

GET /api/openstack-routers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [ports]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: ports

GET /api/openstack-routers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [ports]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: ports

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: RANCHER_USERNAME_INPUT_LABEL

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: RANCHER_USERNAME_INPUT_LABEL

OpenAPI schema diff - 7.5.7

For version 7.5.7

New Endpoints: 2

POST /api/openstack-routers/
DELETE /api/openstack-routers/{uuid}/

Deleted Endpoints: None

Modified Endpoints: None

OpenAPI schema diff - 7.5.8

For version 7.5.8

New Endpoints: None

Deleted Endpoints: None

Modified Endpoints: 6

GET /api/rancher-clusters/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [public_ips]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: public_ips

POST /api/rancher-clusters/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: public_ips

GET /api/rancher-clusters/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [public_ips]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: public_ips

PATCH /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: public_ips

PUT /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: public_ips

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: public_ips

OpenAPI schema diff - 7.5.9

For version 7.5.9

New Endpoints: None

Deleted Endpoints: None

Modified Endpoints: 160

GET /api/aws-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/aws-instances/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/aws-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/aws-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/aws-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/aws-volumes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/aws-volumes/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/aws-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/aws-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/aws-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-public-ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/azure-public-ips/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-public-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/azure-public-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/azure-public-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-resource-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/azure-resource-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-sql-databases/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/azure-sql-databases/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-sql-databases/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/azure-sql-databases/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/azure-sql-databases/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-sql-servers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/azure-sql-servers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-sql-servers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/azure-sql-servers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/azure-sql-servers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-virtualmachines/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/azure-virtualmachines/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/azure-virtualmachines/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/azure-virtualmachines/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/azure-virtualmachines/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/digitalocean-droplets/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/digitalocean-droplets/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/digitalocean-droplets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/digitalocean-droplets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/digitalocean-droplets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_groups
          • Items changed
          • New enum values: [offering_accounting]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_groups
        • Items changed
        • New enum values: [offering_accounting]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_groups
        • Items changed
        • New enum values: [offering_accounting]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_groups
        • Items changed
        • New enum values: [offering_accounting]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_groups
          • Items changed
          • New enum values: [offering_accounting]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_groups
        • Items changed
        • New enum values: [offering_accounting]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_groups
        • Items changed
        • New enum values: [offering_accounting]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_groups
        • Items changed
        • New enum values: [offering_accounting]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_groups
        • Items changed
          • New enum values: [offering_accounting]

GET /api/invoices/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: customer_details
          • Properties changed
          • Modified property: country_name
            • Nullable changed from false to true
        • Modified property: issuer_details
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/CustomerDetails
            • Properties changed
            • Modified property: country_name
              • Nullable changed from false to true

GET /api/invoices/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: customer_details
        • Properties changed
          • Modified property: country_name
          • Nullable changed from false to true
        • Modified property: issuer_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/CustomerDetails
          • Properties changed
            • Modified property: country_name
            • Nullable changed from false to true

POST /api/invoices/{uuid}/paid/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: customer_details
        • Properties changed
          • Modified property: country_name
          • Nullable changed from false to true
        • Modified property: issuer_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/CustomerDetails
          • Properties changed
            • Modified property: country_name
            • Nullable changed from false to true

GET /api/marketplace-customer-service-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
        • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

POST /api/marketplace-customer-service-accounts/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: preferred_identifier
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

GET /api/marketplace-customer-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

PATCH /api/marketplace-customer-service-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: preferred_identifier
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

PUT /api/marketplace-customer-service-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: preferred_identifier
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

GET /api/marketplace-project-service-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
        • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

POST /api/marketplace-project-service-accounts/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: preferred_identifier
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

GET /api/marketplace-project-service-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

PATCH /api/marketplace-project-service-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: preferred_identifier
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

PUT /api/marketplace-project-service-accounts/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: preferred_identifier
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: expires_at
        • Deleted required property: expiresAt
      • Properties changed
        • New property: expires_at
        • New property: preferred_identifier
        • Deleted property: expiresAt

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-backups/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true
        • Modified property: rancher_cluster
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/RancherClusterReference
          • Properties changed
            • Modified property: marketplace_uuid
            • Nullable changed from false to true

GET /api/openstack-floating-ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-floating-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true
        • Modified property: rancher_cluster
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/RancherClusterReference
            • Properties changed
            • Modified property: marketplace_uuid
              • Nullable changed from false to true

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true
        • Modified property: rancher_cluster
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/RancherClusterReference
          • Properties changed
            • Modified property: marketplace_uuid
            • Nullable changed from false to true

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true
        • Modified property: rancher_cluster
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/RancherClusterReference
          • Properties changed
            • Modified property: marketplace_uuid
            • Nullable changed from false to true

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true
        • Modified property: rancher_cluster
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/RancherClusterReference
          • Properties changed
            • Modified property: marketplace_uuid
            • Nullable changed from false to true

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-networks/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-networks/{uuid}/create_subnet/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/openstack-ports/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-routers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-routers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-security-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-security-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-server-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/openstack-server-groups/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-snapshots/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-snapshots/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extend_enabled
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-subnets/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-tenants/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/openstack-tenants/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_floating_ip/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_network/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/create_server_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/pull_security_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-tenants/{uuid}/pull_server_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/openstack-volumes/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [extend_enabled]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: extend_enabled
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/openstack-volumes/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [extend_enabled]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extend_enabled
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/openstack-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extend_enabled
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/openstack-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extend_enabled
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/openstack-volumes/{uuid}/snapshot/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-apps/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/rancher-apps/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/rancher-apps/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-cluster-security-groups/

  • New query param: cluster_uuid

GET /api/rancher-clusters/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/rancher-clusters/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-ingresses/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/rancher-ingresses/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-ingresses/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/rancher-ingresses/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/rancher-ingresses/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-ingresses/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/rancher-ingresses/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-services/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/rancher-services/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-services/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/rancher-services/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/rancher-services/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/rancher-services/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/rancher-services/{uuid}/yaml/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/slurm-allocations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/slurm-allocations/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/slurm-allocations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/slurm-allocations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/slurm-allocations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/vmware-disks/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/vmware-disks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/vmware-ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

GET /api/vmware-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/vmware-virtual-machine/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: marketplace_category_name
          • Nullable changed from false to true

POST /api/vmware-virtual-machine/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

GET /api/vmware-virtual-machine/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PATCH /api/vmware-virtual-machine/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

PUT /api/vmware-virtual-machine/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/vmware-virtual-machine/{uuid}/create_disk/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

POST /api/vmware-virtual-machine/{uuid}/create_port/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: marketplace_category_name
        • Nullable changed from false to true

OpenAPI schema diff - 7.6.0

For version 7.6.0

New Endpoints: 3

GET /api/customer-credits/{uuid}/consumptions/
GET /api/invoice-items/{uuid}/consumptions/
POST /api/marketplace-provider-offerings/{uuid}/move_offering/

Deleted Endpoints: None

Modified Endpoints: 24

GET /api/booking-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
          • Type changed from 'number' to 'object'
          • Format changed from 'double' to ''
          • Nullable changed from true to false
          • AdditionalProperties changed
          • Schema added

GET /api/booking-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

GET /api/marketplace-provider-offerings/{uuid}/list_customer_users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: notifications_enabled

GET /api/marketplace-provider-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
          • Type changed from 'number' to 'object'
          • Format changed from 'double' to ''
          • Nullable changed from true to false
          • AdditionalProperties changed
          • Schema added

GET /api/marketplace-provider-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

GET /api/marketplace-provider-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

POST /api/marketplace-provider-resources/{uuid}/set_as_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

GET /api/marketplace-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
          • Type changed from 'number' to 'object'
          • Format changed from 'double' to ''
          • Nullable changed from true to false
          • AdditionalProperties changed
          • Schema added

GET /api/marketplace-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

GET /api/marketplace-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_settings_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
        • Type changed from 'number' to 'object'
        • Format changed from 'double' to ''
        • Nullable changed from true to false
        • AdditionalProperties changed
          • Schema added

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: CALL_MANAGEMENT_HERO_IMAGE
        • New property: MARKETPLACE_HERO_IMAGE

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: CALL_MANAGEMENT_HERO_IMAGE
      • New property: MARKETPLACE_HERO_IMAGE

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: service_settings_uuid
        • Modified property: limit_usage
          • Type changed from 'number' to 'object'
          • Format changed from 'double' to ''
          • Nullable changed from true to false
          • AdditionalProperties changed
          • Schema added

GET /api/users/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [notifications_enabled]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: notifications_enabled

POST /api/users/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: notifications_enabled
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: notifications_enabled

GET /api/users/me/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [notifications_enabled]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: notifications_enabled

GET /api/users/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [notifications_enabled]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: notifications_enabled

PATCH /api/users/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: notifications_enabled
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: notifications_enabled

PUT /api/users/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: notifications_enabled
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: notifications_enabled

OpenAPI schema diff - 7.6.1

For version 7.6.1

No changes

OpenAPI schema diff - 7.6.2

For version 7.6.2

New Endpoints: 7

POST /api/openstack-ports/{uuid}/update_security_groups/
GET /api/proposal-protected-calls/{uuid}/resource_templates/
POST /api/proposal-protected-calls/{uuid}/resource_templates/
DELETE /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/
PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

Deleted Endpoints: None

Modified Endpoints: 51

GET /api/customers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [max_service_accounts]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: max_service_accounts

POST /api/customers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

GET /api/customers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [max_service_accounts]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

PATCH /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

PUT /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

POST /api/marketplace-component-usages/set_usage/

  • Responses changed
  • New response: 201
  • Deleted response: 200

POST /api/marketplace-component-usages/{uuid}/set_user_usage/

  • Responses changed
  • New response: 201
  • Deleted response: 200

GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: max_service_accounts

GET /api/marketplace-service-providers/{service_provider_uuid}/projects/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [max_service_accounts]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: max_service_accounts

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance_ports
          • Items changed
          • Properties changed
            • New property: security_groups
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: ports
            • Items changed
              • Properties changed
              • New property: security_groups

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: security_groups
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: security_groups

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: security_groups
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: security_groups

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: security_groups
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: security_groups

POST /api/openstack-backups/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: security_groups

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: ports
          • Items changed
          • Properties changed
            • New property: security_groups

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: security_groups

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: security_groups

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: security_groups

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • New property: security_groups
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: ports
            • Items changed
            • Properties changed
              • New property: security_groups

GET /api/openstack-instances/{uuid}/ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: security_groups

GET /api/openstack-ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: security_groups
          • Items changed
          • Properties changed
            • New property: url

POST /api/openstack-ports/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: url

GET /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: url

PATCH /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: url

PUT /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: url

GET /api/openstack-routers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: ports
          • Items changed
          • Properties changed
            • New property: security_groups

GET /api/openstack-routers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: ports
        • Items changed
          • Properties changed
          • New property: security_groups

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: rules
      • Properties changed
      • Deleted property: rules

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND

GET /api/projects/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [max_service_accounts]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: max_service_accounts

POST /api/projects/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

GET /api/projects/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [max_service_accounts]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

PATCH /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

PUT /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

POST /api/projects/{uuid}/move_project/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: max_service_accounts

GET /api/proposal-proposals/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
        • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

POST /api/proposal-proposals/{uuid}/resources/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: requested_offering_uuid
      • Properties changed
      • New property: call_resource_template_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
      • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

GET /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
      • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: call_resource_template_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
      • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: requested_offering_uuid
      • Properties changed
      • New property: call_resource_template_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
      • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

GET /api/proposal-protected-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [fixed_duration_in_days resource_templates]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

POST /api/proposal-protected-calls/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: fixed_duration_in_days
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

GET /api/proposal-protected-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [fixed_duration_in_days resource_templates]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

PATCH /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: fixed_duration_in_days
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

PUT /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: fixed_duration_in_days
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: fixed_duration_in_days
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

GET /api/proposal-public-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [fixed_duration_in_days resource_templates]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

GET /api/proposal-public-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [fixed_duration_in_days resource_templates]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: fixed_duration_in_days
        • New property: resource_templates

GET /api/proposal-requested-resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
        • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

GET /api/proposal-requested-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: call_resource_template
        • New required property: call_resource_template_name
      • Properties changed
        • New property: call_resource_template
        • New property: call_resource_template_name

OpenAPI schema diff - 7.6.3

For version 7.6.3

No changes

OpenAPI schema diff - 7.6.4

For version 7.6.4

New Endpoints: None

Deleted Endpoints: 1

POST /api/openstack-migrations/{uuid}/run/

Modified Endpoints: 42

GET /api/booking-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/booking-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/marketplace-provider-offerings/{uuid}/list_customer_users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: token_expires_at

GET /api/marketplace-provider-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/marketplace-provider-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/marketplace-provider-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Description changed from '' to 'Refresh the last sync time for a resource.'
  • Request body changed
  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-resources/{uuid}/set_as_ok/

  • Description changed from '' to 'Set the resource as OK.'
  • Request body changed
  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/marketplace-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/marketplace-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/marketplace-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [customer_slug project_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: customer_slug
        • New property: project_slug

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: rules
      • Properties changed
      • New property: rules

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: customer_slug
        • New property: project_slug

GET /api/proposal-protected-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [reviewer_identity_visible_to_submitters reviews_visible_to_submitters]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

POST /api/proposal-protected-calls/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: reviewer_identity_visible_to_submitters
      • New property: reviews_visible_to_submitters
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

GET /api/proposal-protected-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [reviewer_identity_visible_to_submitters reviews_visible_to_submitters]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

PATCH /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: reviewer_identity_visible_to_submitters
      • New property: reviews_visible_to_submitters
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

PUT /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: reviewer_identity_visible_to_submitters
      • New property: reviews_visible_to_submitters
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

GET /api/proposal-protected-calls/{uuid}/rounds/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: proposals
          • Items changed
          • Properties changed
            • Modified property: reviews
            • Description changed from '' to 'Return serialized reviews based on user permissions and visibility settings.
  • Staff, call managers, and reviewers see all reviews.
  • Submitters see submitted reviews if visibility is enabled.' - Items changed - Type changed from 'object' to '' - Required changed - Deleted required property: call_name - Deleted required property: call_uuid - Deleted required property: proposal - Deleted required property: proposal_name - Deleted required property: proposal_uuid - Deleted required property: review_end_date - Deleted required property: reviewer - Deleted required property: reviewer_full_name - Deleted required property: reviewer_uuid - Deleted required property: round_cutoff_time - Deleted required property: round_name - Deleted required property: round_start_time - Deleted required property: round_uuid - Deleted required property: state - Deleted required property: url - Deleted required property: uuid - Properties changed - Deleted property: call_name - Deleted property: call_uuid - Deleted property: comment_project_description - Deleted property: comment_project_duration - Deleted property: comment_project_has_civilian_purpose - Deleted property: comment_project_is_confidential - Deleted property: comment_project_summary - Deleted property: comment_project_supporting_documentation - Deleted property: comment_project_title - Deleted property: comment_resource_requests - Deleted property: comment_team - Deleted property: proposal - Deleted property: proposal_name - Deleted property: proposal_uuid - Deleted property: review_end_date - Deleted property: reviewer - Deleted property: reviewer_full_name - Deleted property: reviewer_uuid - Deleted property: round_cutoff_time - Deleted property: round_name - Deleted property: round_start_time - Deleted property: round_uuid - Deleted property: state - Deleted property: summary_private_comment - Deleted property: summary_public_comment - Deleted property: summary_score - Deleted property: url - Deleted property: uuid

POST /api/proposal-protected-calls/{uuid}/rounds/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Description changed from '' to 'Return serialized reviews based on user permissions and visibility settings.
  • Staff, call managers, and reviewers see all reviews.
  • Submitters see submitted reviews if visibility is enabled.' - Items changed - Type changed from 'object' to '' - Required changed - Deleted required property: call_name - Deleted required property: call_uuid - Deleted required property: proposal - Deleted required property: proposal_name - Deleted required property: proposal_uuid - Deleted required property: review_end_date - Deleted required property: reviewer - Deleted required property: reviewer_full_name - Deleted required property: reviewer_uuid - Deleted required property: round_cutoff_time - Deleted required property: round_name - Deleted required property: round_start_time - Deleted required property: round_uuid - Deleted required property: state - Deleted required property: url - Deleted required property: uuid - Properties changed - Deleted property: call_name - Deleted property: call_uuid - Deleted property: comment_project_description - Deleted property: comment_project_duration - Deleted property: comment_project_has_civilian_purpose - Deleted property: comment_project_is_confidential - Deleted property: comment_project_summary - Deleted property: comment_project_supporting_documentation - Deleted property: comment_project_title - Deleted property: comment_resource_requests - Deleted property: comment_team - Deleted property: proposal - Deleted property: proposal_name - Deleted property: proposal_uuid - Deleted property: review_end_date - Deleted property: reviewer - Deleted property: reviewer_full_name - Deleted property: reviewer_uuid - Deleted property: round_cutoff_time - Deleted property: round_name - Deleted property: round_start_time - Deleted property: round_uuid - Deleted property: state - Deleted property: summary_private_comment - Deleted property: summary_public_comment - Deleted property: summary_score - Deleted property: url - Deleted property: uuid

GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Description changed from '' to 'Return serialized reviews based on user permissions and visibility settings.
  • Staff, call managers, and reviewers see all reviews.
  • Submitters see submitted reviews if visibility is enabled.' - Items changed - Type changed from 'object' to '' - Required changed - Deleted required property: call_name - Deleted required property: call_uuid - Deleted required property: proposal - Deleted required property: proposal_name - Deleted required property: proposal_uuid - Deleted required property: review_end_date - Deleted required property: reviewer - Deleted required property: reviewer_full_name - Deleted required property: reviewer_uuid - Deleted required property: round_cutoff_time - Deleted required property: round_name - Deleted required property: round_start_time - Deleted required property: round_uuid - Deleted required property: state - Deleted required property: url - Deleted required property: uuid - Properties changed - Deleted property: call_name - Deleted property: call_uuid - Deleted property: comment_project_description - Deleted property: comment_project_duration - Deleted property: comment_project_has_civilian_purpose - Deleted property: comment_project_is_confidential - Deleted property: comment_project_summary - Deleted property: comment_project_supporting_documentation - Deleted property: comment_project_title - Deleted property: comment_resource_requests - Deleted property: comment_team - Deleted property: proposal - Deleted property: proposal_name - Deleted property: proposal_uuid - Deleted property: review_end_date - Deleted property: reviewer - Deleted property: reviewer_full_name - Deleted property: reviewer_uuid - Deleted property: round_cutoff_time - Deleted property: round_name - Deleted property: round_start_time - Deleted property: round_uuid - Deleted property: state - Deleted property: summary_private_comment - Deleted property: summary_public_comment - Deleted property: summary_score - Deleted property: url - Deleted property: uuid

PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Description changed from '' to 'Return serialized reviews based on user permissions and visibility settings.
  • Staff, call managers, and reviewers see all reviews.
  • Submitters see submitted reviews if visibility is enabled.' - Items changed - Type changed from 'object' to '' - Required changed - Deleted required property: call_name - Deleted required property: call_uuid - Deleted required property: proposal - Deleted required property: proposal_name - Deleted required property: proposal_uuid - Deleted required property: review_end_date - Deleted required property: reviewer - Deleted required property: reviewer_full_name - Deleted required property: reviewer_uuid - Deleted required property: round_cutoff_time - Deleted required property: round_name - Deleted required property: round_start_time - Deleted required property: round_uuid - Deleted required property: state - Deleted required property: url - Deleted required property: uuid - Properties changed - Deleted property: call_name - Deleted property: call_uuid - Deleted property: comment_project_description - Deleted property: comment_project_duration - Deleted property: comment_project_has_civilian_purpose - Deleted property: comment_project_is_confidential - Deleted property: comment_project_summary - Deleted property: comment_project_supporting_documentation - Deleted property: comment_project_title - Deleted property: comment_resource_requests - Deleted property: comment_team - Deleted property: proposal - Deleted property: proposal_name - Deleted property: proposal_uuid - Deleted property: review_end_date - Deleted property: reviewer - Deleted property: reviewer_full_name - Deleted property: reviewer_uuid - Deleted property: round_cutoff_time - Deleted property: round_name - Deleted property: round_start_time - Deleted property: round_uuid - Deleted property: state - Deleted property: summary_private_comment - Deleted property: summary_public_comment - Deleted property: summary_score - Deleted property: url - Deleted property: uuid

PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: proposals
        • Items changed
          • Properties changed
          • Modified property: reviews
            • Description changed from '' to 'Return serialized reviews based on user permissions and visibility settings.
  • Staff, call managers, and reviewers see all reviews.
  • Submitters see submitted reviews if visibility is enabled.' - Items changed - Type changed from 'object' to '' - Required changed - Deleted required property: call_name - Deleted required property: call_uuid - Deleted required property: proposal - Deleted required property: proposal_name - Deleted required property: proposal_uuid - Deleted required property: review_end_date - Deleted required property: reviewer - Deleted required property: reviewer_full_name - Deleted required property: reviewer_uuid - Deleted required property: round_cutoff_time - Deleted required property: round_name - Deleted required property: round_start_time - Deleted required property: round_uuid - Deleted required property: state - Deleted required property: url - Deleted required property: uuid - Properties changed - Deleted property: call_name - Deleted property: call_uuid - Deleted property: comment_project_description - Deleted property: comment_project_duration - Deleted property: comment_project_has_civilian_purpose - Deleted property: comment_project_is_confidential - Deleted property: comment_project_summary - Deleted property: comment_project_supporting_documentation - Deleted property: comment_project_title - Deleted property: comment_resource_requests - Deleted property: comment_team - Deleted property: proposal - Deleted property: proposal_name - Deleted property: proposal_uuid - Deleted property: review_end_date - Deleted property: reviewer - Deleted property: reviewer_full_name - Deleted property: reviewer_uuid - Deleted property: round_cutoff_time - Deleted property: round_name - Deleted property: round_start_time - Deleted property: round_uuid - Deleted property: state - Deleted property: summary_private_comment - Deleted property: summary_public_comment - Deleted property: summary_score - Deleted property: url - Deleted property: uuid

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: reviewer_identity_visible_to_submitters
      • New property: reviews_visible_to_submitters
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

GET /api/proposal-public-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [reviewer_identity_visible_to_submitters reviews_visible_to_submitters]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

GET /api/proposal-public-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [reviewer_identity_visible_to_submitters reviews_visible_to_submitters]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: reviewer_identity_visible_to_submitters
        • New property: reviews_visible_to_submitters

GET /api/proposal-reviews/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: anonymous_reviewer_name
        • Properties changed
        • New property: anonymous_reviewer_name

POST /api/proposal-reviews/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: anonymous_reviewer_name
      • Properties changed
        • New property: anonymous_reviewer_name

GET /api/proposal-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: anonymous_reviewer_name
      • Properties changed
        • New property: anonymous_reviewer_name

PATCH /api/proposal-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: anonymous_reviewer_name
      • Properties changed
        • New property: anonymous_reviewer_name

PUT /api/proposal-reviews/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: anonymous_reviewer_name
      • Properties changed
        • New property: anonymous_reviewer_name

GET /api/user-invitations/

  • Modified query param: o
  • Schema changed
    • Items changed
    • New enum values: [-created_by created_by]

GET /api/users/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [token_expires_at]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: token_expires_at

POST /api/users/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: token_expires_at

GET /api/users/me/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [token_expires_at]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: token_expires_at

GET /api/users/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [token_expires_at]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: token_expires_at

PATCH /api/users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: token_expires_at

PUT /api/users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: token_expires_at

OpenAPI schema diff - 7.6.5

For version 7.6.5

New Endpoints: 17

GET /api/autoprovisioning-rule-plans/
POST /api/autoprovisioning-rule-plans/
DELETE /api/autoprovisioning-rule-plans/{uuid}/
GET /api/autoprovisioning-rule-plans/{uuid}/
PATCH /api/autoprovisioning-rule-plans/{uuid}/
PUT /api/autoprovisioning-rule-plans/{uuid}/
GET /api/autoprovisioning-rules/
POST /api/autoprovisioning-rules/
DELETE /api/autoprovisioning-rules/{uuid}/
GET /api/autoprovisioning-rules/{uuid}/
PATCH /api/autoprovisioning-rules/{uuid}/
PUT /api/autoprovisioning-rules/{uuid}/
GET /api/openstack-marketplace-tenants/
GET /api/openstack-marketplace-tenants/{uuid}/
POST /api/openstack-marketplace-tenants/{uuid}/create_image/
POST /api/openstack-marketplace-tenants/{uuid}/upload_image_data/{image_id}/
POST /api/projects/{uuid}/sync_user_roles/

Deleted Endpoints: None

Modified Endpoints: 1168

POST /api-auth/logout/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api-auth/password/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api-auth/saml2/providers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/access-subnets/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/access-subnets/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/access-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/access-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/access-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/access-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/admin-announcements/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/admin-announcements/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/admin-announcements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/admin-announcements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/admin-announcements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/admin-announcements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/auth-tokens/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/auth-tokens/{user_id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/auth-tokens/{user_id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/auth-valimo/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/auth-valimo/result/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-images/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-images/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-instances/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/aws-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/aws-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/aws-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/{uuid}/resize/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/{uuid}/restart/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/{uuid}/start/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/{uuid}/stop/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-instances/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-regions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-regions/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-sizes/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-sizes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-volumes/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-volumes/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/aws-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/aws-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/aws-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/aws-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-volumes/{uuid}/attach/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-volumes/{uuid}/detach/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-volumes/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/aws-volumes/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-images/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-images/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-locations/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-locations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-public-ips/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-public-ips/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/azure-public-ips/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-public-ips/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/azure-public-ips/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/azure-public-ips/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-public-ips/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-public-ips/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-resource-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-resource-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-sizes/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-sizes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-sql-databases/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-databases/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/azure-sql-databases/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-sql-databases/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/azure-sql-databases/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/azure-sql-databases/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-databases/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-databases/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-sql-servers/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-servers/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/azure-sql-servers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-sql-servers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/azure-sql-servers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/azure-sql-servers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-servers/{uuid}/create_database/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-servers/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-sql-servers/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-virtualmachines/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-virtualmachines/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/azure-virtualmachines/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/azure-virtualmachines/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/azure-virtualmachines/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/azure-virtualmachines/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-virtualmachines/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-virtualmachines/{uuid}/restart/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-virtualmachines/{uuid}/start/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-virtualmachines/{uuid}/stop/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/azure-virtualmachines/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/billing-total-cost/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/booking-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/booking-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/booking-offerings/{uuid}/google_calendar_sync/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/booking-offerings/{uuid}/share_google_calendar/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/booking-offerings/{uuid}/unshare_google_calendar/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/booking-resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/booking-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/booking-resources/{uuid}/accept/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/booking-resources/{uuid}/reject/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/broadcast-message-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/broadcast-message-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/broadcast-message-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/broadcast-message-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/broadcast-message-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/broadcast-message-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/broadcast-messages/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/broadcast-messages/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/broadcast-messages/recipients/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/broadcast-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/broadcast-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/broadcast-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/broadcast-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/broadcast-messages/{uuid}/send/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-managing-organisations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/call-managing-organisations/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/call-managing-organisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-managing-organisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/call-managing-organisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/call-managing-organisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/call-managing-organisations/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/call-managing-organisations/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-managing-organisations/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-managing-organisations/{uuid}/stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/call-managing-organisations/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-rounds/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-rounds/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/call-rounds/{uuid}/reviewers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/celery-stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/component-user-usage-limits/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/component-user-usage-limits/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/component-user-usage-limits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/component-user-usage-limits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/component-user-usage-limits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/component-user-usage-limits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/configuration/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customer-credits/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customer-credits/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/customer-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customer-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/customer-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/customer-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customer-credits/{uuid}/apply_compensations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customer-credits/{uuid}/clear_compensations/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customer-credits/{uuid}/consumptions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customer-permissions-reviews/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customer-permissions-reviews/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customer-permissions-reviews/{uuid}/close/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customer-quotas/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/countries/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/{customer_uuid}/marketplace-checklists/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customers/{customer_uuid}/marketplace-checklists/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/{customer_uuid}/marketplace-checklists/{checklist_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/customers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/customers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/customers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customers/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customers/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/{uuid}/stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customers/{uuid}/update_organization_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/customers/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/customers/{uuid}/users/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [role]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: role
        • Modified property: expiration_time
          • Nullable changed from false to true
        • Modified property: role_name
          • Nullable changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/daily-quotas/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/database-stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-droplets/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/digitalocean-droplets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-droplets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/digitalocean-droplets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/digitalocean-droplets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/{uuid}/resize/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/{uuid}/restart/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/{uuid}/start/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/{uuid}/stop/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/digitalocean-droplets/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-images/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-images/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-regions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-regions/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-sizes/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/digitalocean-sizes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/email-logs/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/email-logs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/event-subscriptions/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/event-subscriptions/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/event-subscriptions/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/event-subscriptions/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/events-stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/events/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/events/count/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/events/event_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/events/scope_types/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/events/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/feature-values/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/financial-reports/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/financial-reports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/freeipa-profiles/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/freeipa-profiles/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/freeipa-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/freeipa-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/freeipa-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/freeipa-profiles/{uuid}/update_ssh_keys/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/google-auth/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/google-auth/callback/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/google-auth/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/google-auth/{uuid}/authorize/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/hooks-email/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/hooks-email/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/hooks-email/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/hooks-email/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/hooks-email/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/hooks-email/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/hooks-web/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/hooks-web/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/hooks-web/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/hooks-web/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/hooks-web/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/hooks-web/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/hooks/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/identity-providers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: extra_scope
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/identity-providers/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: extra_scope
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extra_scope
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/identity-providers/{provider}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/identity-providers/{provider}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extra_scope
  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/identity-providers/{provider}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: extra_scope
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extra_scope
  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/identity-providers/{provider}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: extra_scope
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: extra_scope
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/costs/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/customer_costs_for_period/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/project_costs_for_period/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/total_price/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/invoice-items/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/invoice-items/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/invoice-items/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoice-items/{uuid}/consumptions/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoice-items/{uuid}/create_compensation/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoice-items/{uuid}/migrate_to/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoice/send-financial-report-by-mail/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoices/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoices/growth/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoices/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoices/{uuid}/items/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoices/{uuid}/paid/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoices/{uuid}/send_notification/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoices/{uuid}/set_backend_id/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoices/{uuid}/set_payment_url/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/invoices/{uuid}/set_reference_number/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/invoices/{uuid}/stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/keycloak-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/keycloak-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/keycloak-user-group-memberships/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/keycloak-user-group-memberships/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/keycloak-user-group-memberships/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/keycloak-user-group-memberships/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/keycloak-user-group-memberships/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/keycloak-user-group-memberships/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/keys/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/keys/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/keys/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/keys/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/lexis-links/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/lexis-links/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/lexis-links/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/lexis-links/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/lexis-links/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/lexis-links/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-bookings/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-categories/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-categories/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-categories/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-categories/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-categories/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-categories/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-columns/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-category-columns/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-category-columns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-columns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-category-columns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-category-columns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-component-usages/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-component-usages/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-components/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-category-components/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-category-components/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-components/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-category-components/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-category-components/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-category-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-category-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-category-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-category-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-help-articles/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-category-help-articles/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-category-help-articles/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-category-help-articles/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-category-help-articles/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-category-help-articles/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists-categories/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists-categories/{category_uuid}/checklists/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists-categories/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists/{checklist_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists/{checklist_uuid}/answers/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-checklists/{checklist_uuid}/answers/submit/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists/{checklist_uuid}/questions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists/{checklist_uuid}/stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-checklists/{checklist_uuid}/user/{user_uuid}/answers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-component-usages/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-component-usages/set_usage/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-component-usages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-component-usages/{uuid}/set_user_usage/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-component-user-usages/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-component-user-usages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-customer-estimated-cost-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-customer-estimated-cost-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-customer-estimated-cost-policies/actions/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-customer-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-customer-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-customer-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-customer-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-customer-service-accounts/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-customer-service-accounts/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-customer-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-customer-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-customer-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-customer-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-global-categories/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-integration-statuses/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-integration-statuses/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-estimated-cost-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-offering-estimated-cost-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-estimated-cost-policies/actions/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-offering-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-offering-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-offering-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-files/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-offering-files/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-offering-files/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-files/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-permissions-log/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: role
          • Format changed from '' to 'uri'
          • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-permissions-log/{id}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: role
        • Format changed from '' to 'uri'
        • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-permissions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: role
          • Format changed from '' to 'uri'
          • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-permissions/{id}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: role
        • Format changed from '' to 'uri'
        • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-referrals/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-referrals/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-usage-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-offering-usage-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-usage-policies/actions/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-offering-usage-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-usage-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-offering-usage-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-offering-usage-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-user-roles/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-offering-user-roles/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-offering-user-roles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-user-roles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-offering-user-roles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-offering-user-roles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offering_uuid
          • ReadOnly changed from true to false
        • Modified property: user_uuid
          • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-offering-users/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: offering
      • Deleted required property: user
      • Properties changed
      • New property: offering_uuid
      • New property: user_uuid
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_uuid
        • ReadOnly changed from true to false
        • Modified property: user_uuid
        • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-offering-users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_uuid
        • ReadOnly changed from true to false
        • Modified property: user_uuid
        • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-offering-users/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: offering_uuid
      • New property: user_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_uuid
        • ReadOnly changed from true to false
        • Modified property: user_uuid
        • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-offering-users/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • Deleted required property: offering
      • Deleted required property: user
      • Properties changed
      • New property: offering_uuid
      • New property: user_uuid
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_uuid
        • ReadOnly changed from true to false
        • Modified property: user_uuid
        • ReadOnly changed from true to false
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-offering-users/{uuid}/update_restricted/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-orders/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: output
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: output
      • Properties changed
        • Modified property: output
        • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-orders/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-orders/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/approve_by_consumer/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/approve_by_provider/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/cancel/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/reject_by_consumer/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/reject_by_provider/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/set_state_done/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/set_state_erred/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/set_state_executing/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-orders/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-plan-components/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-plan-components/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-plans/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-plans/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-plans/usage_stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-plans/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-plans/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-plans/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-plans/{uuid}/archive/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-plans/{uuid}/delete_organization_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-plans/{uuid}/update_organization_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-plans/{uuid}/update_prices/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-plans/{uuid}/update_quotas/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-estimated-cost-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-project-estimated-cost-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-estimated-cost-policies/actions/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-project-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-project-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-project-estimated-cost-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-service-accounts/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-project-service-accounts/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-project-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-project-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-project-service-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-update-requests/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-project-update-requests/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-project-update-requests/{uuid}/approve/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-project-update-requests/{uuid}/reject/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/

  • New query param: uuid_list
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/groups/

  • New query param: uuid_list
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-provider-offerings/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/activate/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/add_endpoint/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/archive/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/component_stats/

  • New query param: uuid_list
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/costs/

  • New query param: uuid_list
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/create_offering_component/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/customers/

  • New query param: uuid_list
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/delete_endpoint/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/delete_image/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/delete_organization_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/delete_thumbnail/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/draft/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/glauth_users_config/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/importable_resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/list_customer_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/pause/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/remove_offering_component/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/sync/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/unpause/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_attributes/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_description/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plugin_options
        • Properties changed
        • New property: managed_rancher_tenant_max_cpu
        • New property: managed_rancher_tenant_max_disk
        • New property: managed_rancher_tenant_max_ram
        • Deleted property: managed_rancher_load_balancer_cloud_init_template
      • Modified property: secret_options
        • Properties changed
        • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_location/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_options/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_organization_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_overview/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_resource_options/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_thumbnail/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-offerings/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
        • Modified property: secret_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
          • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-provider-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-provider-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/details/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/glauth_users_config/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/offering_for_subresources/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/plan_periods/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_as_erred/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_as_ok/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_backend_id/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_backend_metadata/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_limits/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/set_slug/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/submit_report/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-provider-resources/{uuid}/team/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/terminate/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-provider-resources/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-public-api/check_signature/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-public-api/set_usage/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-public-offerings/

  • New query param: uuid_list
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-public-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-public-offerings/{uuid}/plans/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-related-customers/{customer_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-remote-synchronisations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-remote-synchronisations/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-remote-synchronisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-remote-synchronisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-remote-synchronisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-remote-synchronisations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-remote-synchronisations/{uuid}/run_synchronisation/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resource-offerings/{category_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resource-users/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resource-users/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-resource-users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resource-users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/suggest_name/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/details/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/glauth_users_config/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/move_resource/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/offering_for_subresources/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/plan_periods/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/set_end_date_by_staff/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/set_slug/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/switch_plan/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-resources/{uuid}/team/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/terminate/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/update_limits/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-resources/{uuid}/update_options/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offering_plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-robot-accounts/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-robot-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-robot-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-robot-accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-runtime-states/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-screenshots/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-screenshots/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-screenshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-screenshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-screenshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-screenshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-script-async-dry-run/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-script-async-dry-run/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: managed_rancher_tenant_max_cpu
            • New property: managed_rancher_tenant_max_disk
            • New property: managed_rancher_tenant_max_ram
            • Deleted property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-script-sync-resource/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-sections/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-sections/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-sections/{key}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-sections/{key}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-sections/{key}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-sections/{key}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-service-providers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/customers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/keys/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • New query param: uuid_list
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: secret_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedSecretOptions
            • Properties changed
            • New property: managed_rancher_load_balancer_cloud_init_template
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/user_customers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{service_provider_uuid}/users/

  • New query param: username_list
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/marketplace-service-providers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/marketplace-service-providers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/marketplace-service-providers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-service-providers/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/api_secret_code/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-service-providers/{uuid}/api_secret_code/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-service-providers/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/revenue/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/robot_account_customers/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/robot_account_projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-service-providers/{uuid}/set_offerings_username/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-service-providers/{uuid}/stat/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/marketplace-service-providers/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/component_usages/

  • OperationID changed from 'marketplace_stats_component_usages_retrieve' to 'marketplace_stats_component_usages_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/component_usages_per_month/

  • OperationID changed from 'marketplace_stats_component_usages_per_month_retrieve' to 'marketplace_stats_component_usages_per_month_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/component_usages_per_project/

  • OperationID changed from 'marketplace_stats_component_usages_per_project_retrieve' to 'marketplace_stats_component_usages_per_project_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_active_resources_grouped_by_offering/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_active_resources_grouped_by_offering_country/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_active_resources_grouped_by_organization_group/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_projects_of_service_providers/

  • OperationID changed from 'marketplace_stats_count_projects_of_service_providers_retrieve' to 'marketplace_stats_count_projects_of_service_providers_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/

  • OperationID changed from 'marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_retrieve' to 'marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/

  • OperationID changed from 'marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_retrieve' to 'marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/count_users_of_service_providers/

  • OperationID changed from 'marketplace_stats_count_users_of_service_providers_retrieve' to 'marketplace_stats_count_users_of_service_providers_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/customer_member_count/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/offerings_counter_stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/organization_project_count/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/organization_resource_count/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/projects_limits_grouped_by_industry_flag/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/projects_limits_grouped_by_oecd/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/projects_usages_grouped_by_industry_flag/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/projects_usages_grouped_by_oecd/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/resources_limits/

  • OperationID changed from 'marketplace_stats_resources_limits_retrieve' to 'marketplace_stats_resources_limits_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/marketplace-stats/total_cost_of_active_resources_per_offering/

  • OperationID changed from 'marketplace_stats_total_cost_of_active_resources_per_offering_retrieve' to 'marketplace_stats_total_cost_of_active_resources_per_offering_list'
  • New query param: page
  • New query param: page_size
  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/media/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/notification-messages-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/notification-messages-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/notification-messages-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/notification-messages-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/notification-messages-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/notification-messages-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/notification-messages-templates/{uuid}/override/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/notification-messages/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/notification-messages/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/notification-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/notification-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/notification-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/notification-messages/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/notification-messages/{uuid}/disable/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/notification-messages/{uuid}/enable/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-backups/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-backups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-backups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-backups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-backups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-backups/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-backups/{uuid}/restore/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-backups/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-flavors/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-flavors/usage_stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-flavors/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-floating-ips/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-floating-ips/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-floating-ips/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-floating-ips/{uuid}/attach_to_port/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-floating-ips/{uuid}/detach_from_port/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-floating-ips/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-floating-ips/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-floating-ips/{uuid}/update_description/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-images/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-images/usage_stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-images/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instance-availability-zones/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instance-availability-zones/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instances/

  • New query param: query
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-instances/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/backup/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/change_flavor/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instances/{uuid}/console/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instances/{uuid}/console_log/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instances/{uuid}/floating_ips/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-instances/{uuid}/ports/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/restart/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/start/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/stop/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/update_allowed_address_pairs/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/update_floating_ips/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/update_ports/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-instances/{uuid}/update_security_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-migrations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-migrations/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-migrations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-migrations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-migrations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-migrations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-network-rbac-policies/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-network-rbac-policies/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-networks/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-networks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-networks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-networks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-networks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-networks/{uuid}/create_subnet/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-networks/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-networks/{uuid}/rbac_policy_create/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-networks/{uuid}/set_mtu/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-networks/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-ports/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-ports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-ports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-ports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-ports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/disable_port/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/disable_port_security/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/enable_port/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/enable_port_security/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/update_port_ip/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-ports/{uuid}/update_security_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-routers/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-routers/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-routers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-routers/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-routers/{uuid}/add_router_interface/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-routers/{uuid}/remove_router_interface/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-routers/{uuid}/set_routes/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-security-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-security-groups/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-security-groups/{uuid}/set_rules/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-security-groups/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-server-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-server-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-server-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-server-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-server-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-server-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-server-groups/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-server-groups/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-snapshots/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-snapshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-snapshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-snapshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-snapshots/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-snapshots/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-snapshots/{uuid}/restorations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-snapshots/{uuid}/restore/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-snapshots/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-subnets/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-subnets/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-subnets/{uuid}/connect/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-subnets/{uuid}/disconnect/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-subnets/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-subnets/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-tenants/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/openstack-tenants/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-tenants/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-tenants/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-tenants/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-tenants/{uuid}/backend_instances/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-tenants/{uuid}/backend_volumes/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/change_password/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/create_floating_ip/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/create_network/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Responses changed
  • New response: 201
  • Deleted response: 200
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/create_server_group/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/pull_floating_ips/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/pull_quotas/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/pull_security_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/pull_server_groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/set_quotas/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-tenants/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-volume-availability-zones/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-volume-availability-zones/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-volume-types/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-volume-types/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-volumes/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/openstack-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/openstack-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/openstack-volumes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/attach/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/detach/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/extend/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/retype/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/snapshot/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/openstack-volumes/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/organization-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/organization-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/organization-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/organization-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/organization-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/organization-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: OIDC_AUTH_URL
        • New property: OIDC_CACHE_TIMEOUT
        • New property: OIDC_CLIENT_ID
        • New property: OIDC_CLIENT_SECRET
        • New property: OIDC_INTROSPECTION_URL
        • New property: OIDC_USER_FIELD
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: OIDC_AUTH_URL
      • New property: OIDC_CACHE_TIMEOUT
      • New property: OIDC_CLIENT_ID
      • New property: OIDC_CLIENT_SECRET
      • New property: OIDC_INTROSPECTION_URL
      • New property: OIDC_USER_FIELD
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/payment-profiles/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/payment-profiles/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/payment-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/payment-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/payment-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/payment-profiles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/payment-profiles/{uuid}/enable/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/payments/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/payments/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/payments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/payments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/payments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/payments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/payments/{uuid}/link_to_invoice/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/payments/{uuid}/unlink_from_invoice/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/project-credits/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/project-credits/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/project-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/project-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/project-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/project-credits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/project-quotas/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/project-types/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/project-types/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/projects/{project_uuid}/marketplace-checklists/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/projects/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/projects/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/projects/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/projects/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/projects/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/projects/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/projects/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/projects/{uuid}/move_project/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/projects/{uuid}/other_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/projects/{uuid}/stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/projects/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/promotions-campaigns/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/promotions-campaigns/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/promotions-campaigns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/promotions-campaigns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/promotions-campaigns/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/promotions-campaigns/{uuid}/activate/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/promotions-campaigns/{uuid}/orders/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/promotions-campaigns/{uuid}/resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/promotions-campaigns/{uuid}/terminate/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-proposals/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-proposals/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-proposals/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/approve/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/attach_document/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-proposals/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/reject/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-proposals/{uuid}/resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/submit/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/update_project_details/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-proposals/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-protected-calls/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/proposal-protected-calls/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/proposal-protected-calls/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/activate/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/add_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/archive/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/attach_documents/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/delete_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/detach_documents/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/list_users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/offerings/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/offerings/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/resource_templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/resource_templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/rounds/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/rounds/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-protected-calls/{uuid}/update_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-public-calls/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-public-calls/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-requested-offerings/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-requested-offerings/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-requested-offerings/{uuid}/accept/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-requested-offerings/{uuid}/cancel/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-requested-resources/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-requested-resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-reviews/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-reviews/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/proposal-reviews/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/proposal-reviews/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/proposal-reviews/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/proposal-reviews/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-reviews/{uuid}/accept/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-reviews/{uuid}/reject/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/proposal-reviews/{uuid}/submit/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/provider-invoice-items/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/provider-invoice-items/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/query/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rabbitmq-user-stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rabbitmq-vhost-stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-apps/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-apps/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-apps/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-apps/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-apps/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-apps/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-apps/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-apps/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-catalogs/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-catalogs/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-catalogs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-catalogs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-catalogs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-catalogs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-catalogs/{uuid}/refresh/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-cluster-security-groups/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-cluster-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-cluster-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-cluster-security-groups/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-cluster-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-cluster-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-clusters/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [capacity kubernetes_version requested router_ips]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: capacity
        • New property: kubernetes_version
        • New property: requested
        • New property: router_ips
        • Modified property: public_ips
          • Items changed
          • Properties changed
            • New property: external_ip_address
            • New property: floating_ip_uuid
            • Deleted property: cluster
            • Modified property: floating_ip
            • Nullable changed from true to false
            • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-clusters/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: capacity
        • New property: kubernetes_version
        • New property: requested
        • New property: router_ips
        • Modified property: public_ips
        • Items changed
          • Properties changed
          • New property: external_ip_address
          • New property: floating_ip_uuid
          • Deleted property: cluster
          • Modified property: floating_ip
            • Nullable changed from true to false
            • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-clusters/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-clusters/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [capacity kubernetes_version requested router_ips]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: capacity
        • New property: kubernetes_version
        • New property: requested
        • New property: router_ips
        • Modified property: public_ips
        • Items changed
          • Properties changed
          • New property: external_ip_address
          • New property: floating_ip_uuid
          • Deleted property: cluster
          • Modified property: floating_ip
            • Nullable changed from true to false
            • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: capacity
        • New property: kubernetes_version
        • New property: requested
        • New property: router_ips
        • Modified property: public_ips
        • Items changed
          • Properties changed
          • New property: external_ip_address
          • New property: floating_ip_uuid
          • Deleted property: cluster
          • Modified property: floating_ip
            • Nullable changed from true to false
            • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-clusters/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: capacity
        • New property: kubernetes_version
        • New property: requested
        • New property: router_ips
        • Modified property: public_ips
        • Items changed
          • Properties changed
          • New property: external_ip_address
          • New property: floating_ip_uuid
          • Deleted property: cluster
          • Modified property: floating_ip
            • Nullable changed from true to false
            • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-clusters/{uuid}/create_management_security_group/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: capacity
        • New property: kubernetes_version
        • New property: requested
        • New property: router_ips
        • Modified property: public_ips
        • Items changed
          • Properties changed
          • New property: external_ip_address
          • New property: floating_ip_uuid
          • Deleted property: cluster
          • Modified property: floating_ip
            • Nullable changed from true to false
            • ReadOnly changed from false to true
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-clusters/{uuid}/import_yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-clusters/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-clusters/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-hpas/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-hpas/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-hpas/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-hpas/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-hpas/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-hpas/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-hpas/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-hpas/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-hpas/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-hpas/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-ingresses/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-ingresses/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-ingresses/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-ingresses/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-ingresses/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-ingresses/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-ingresses/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-ingresses/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-ingresses/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-ingresses/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-namespaces/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-namespaces/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-nodes/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-nodes/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-nodes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-nodes/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-nodes/{uuid}/console/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-nodes/{uuid}/console_log/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-nodes/{uuid}/link_openstack/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-nodes/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-nodes/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-nodes/{uuid}/unlink_openstack/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-projects/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-projects/{uuid}/secrets/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-role-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-role-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-services/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-services/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-services/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-services/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-services/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-services/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-services/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-services/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-services/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-services/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-template-versions/{template_uuid}/{version}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-workloads/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-workloads/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/rancher-workloads/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-workloads/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/rancher-workloads/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-workloads/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/rancher-workloads/{uuid}/redeploy/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/rancher-workloads/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/rancher-workloads/{uuid}/yaml/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-eduteams/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/cancel_termination/{uuid}

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/import_offering/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_details/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_invoices/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_orders/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_resources/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_robot_accounts/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_usage/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_offering_users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/pull_order/{uuid}

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/push_project_data/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/remote_categories/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/remote_customers/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/shared_offerings/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/sync_resource/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/remote-waldur-api/sync_resource_project_permissions/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/roles/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [users_count]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: users_count
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/roles/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: users_count
  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/roles/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/roles/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [users_count]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: users_count
  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/roles/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: users_count
  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/roles/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: users_count
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/roles/{uuid}/disable/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/roles/{uuid}/enable/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/roles/{uuid}/update_descriptions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/service-settings/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/service-settings/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-allocation-user-usage/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-allocation-user-usage/{id}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-allocations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-allocations/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/slurm-allocations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-allocations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/slurm-allocations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/slurm-allocations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-allocations/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-allocations/{uuid}/set_limits/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-allocations/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-associations/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-associations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-jobs/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-jobs/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/slurm-jobs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/slurm-jobs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/slurm-jobs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/slurm-jobs/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-jobs/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/slurm-jobs/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-attachments/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-attachments/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/support-attachments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-attachments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-comments/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/support-comments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-comments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/support-comments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/support-comments/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-feedback-average-report/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-feedback-report/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-feedbacks/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-feedbacks/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-feedbacks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-issues/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-issues/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/support-issues/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-issues/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/support-issues/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/support-issues/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-issues/{uuid}/comment/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-issues/{uuid}/sync/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-priorities/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-priorities/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-statistics/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/support-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/support-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/support-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-templates/{uuid}/create_attachments/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/support-templates/{uuid}/delete_attachments/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-users/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/support-users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/sync-issues/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/sync-issues/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-agreements/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-agreements/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/user-agreements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-agreements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/user-agreements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/user-agreements/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-group-invitations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: auto_create_project
        • New property: project_name_template
        • New property: project_role
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-group-invitations/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: auto_create_project
      • New property: project_name_template
      • New property: project_role
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: auto_create_project
        • New property: project_name_template
        • New property: project_role
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-group-invitations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: auto_create_project
        • New property: project_name_template
        • New property: project_role
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-group-invitations/{uuid}/cancel/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-group-invitations/{uuid}/projects/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-group-invitations/{uuid}/submit_request/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: auto_create_project
        • New property: project_name_template
        • New property: project_role
  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-invitations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/approve/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/reject/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-invitations/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/{uuid}/accept/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/{uuid}/cancel/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/{uuid}/check/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/{uuid}/delete/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-invitations/{uuid}/details/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-invitations/{uuid}/send/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-permission-requests/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-permission-requests/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-permission-requests/{uuid}/approve/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/user-permission-requests/{uuid}/reject/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-permissions/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/user-permissions/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/users/

  • New query param: username_list
  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/confirm_email/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/users/me/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/users/{user_uuid}/marketplace-checklist-stats/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/users/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/{uuid}/cancel_change_email/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/{uuid}/change_email/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/{uuid}/change_password/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/{uuid}/pull_remote_user/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/users/{uuid}/refresh_token/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/users/{uuid}/token/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/version/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-clusters/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-clusters/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-datastores/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-datastores/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-disks/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/vmware-disks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-disks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-disks/{uuid}/extend/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-disks/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-disks/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-folders/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-folders/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-limits/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-networks/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-networks/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-ports/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/vmware-ports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-ports/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-ports/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-ports/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-templates/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-templates/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-virtual-machine/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/

  • Security changed
  • New security requirements: waldurOIDCAuth

DELETE /api/vmware-virtual-machine/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-virtual-machine/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PATCH /api/vmware-virtual-machine/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

PUT /api/vmware-virtual-machine/{uuid}/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-virtual-machine/{uuid}/console/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/create_disk/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/create_port/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/pull/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/reboot_guest/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/reset/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/shutdown_guest/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/start/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/stop/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/suspend/

  • Security changed
  • New security requirements: waldurOIDCAuth

POST /api/vmware-virtual-machine/{uuid}/unlink/

  • Security changed
  • New security requirements: waldurOIDCAuth

GET /api/vmware-virtual-machine/{uuid}/web_console/

  • Security changed
  • New security requirements: waldurOIDCAuth

OpenAPI schema diff - 7.6.6

For version 7.6.6

No changes

OpenAPI schema diff - 7.6.7

For version 7.6.7

New Endpoints: None

Deleted Endpoints: None

Modified Endpoints: 21

GET /api/customers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [projects]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: projects

POST /api/customers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: projects

GET /api/customers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [projects]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: projects

PATCH /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: projects

PUT /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: projects

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [user_deactivated_no_roles]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [user_deactivated_no_roles]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [user_deactivated_no_roles]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [user_deactivated_no_roles]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [user_deactivated_no_roles]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [user_deactivated_no_roles]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [user_deactivated_no_roles]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [user_deactivated_no_roles]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [user_deactivated_no_roles]

GET /api/marketplace-offering-permissions-log/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: role
          • ReadOnly changed from false to true

GET /api/marketplace-offering-permissions-log/{id}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: role
        • ReadOnly changed from false to true

GET /api/marketplace-offering-permissions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: role
          • ReadOnly changed from false to true

GET /api/marketplace-offering-permissions/{id}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: role
        • ReadOnly changed from false to true

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: DEACTIVATE_USER_IF_NO_ROLES

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: DEACTIVATE_USER_IF_NO_ROLES

OpenAPI schema diff - 7.6.8

For version 7.6.8

New Endpoints: 35

GET /api/backend-resource-requests/
POST /api/backend-resource-requests/
GET /api/backend-resource-requests/{uuid}/
POST /api/backend-resource-requests/{uuid}/set_done/
POST /api/backend-resource-requests/{uuid}/set_erred/
POST /api/backend-resource-requests/{uuid}/start_processing/
GET /api/backend-resources/
POST /api/backend-resources/
DELETE /api/backend-resources/{uuid}/
GET /api/backend-resources/{uuid}/
POST /api/backend-resources/{uuid}/import_resource/
GET /api/marketplace-maintenance-announcement-offerings/
POST /api/marketplace-maintenance-announcement-offerings/
DELETE /api/marketplace-maintenance-announcement-offerings/{uuid}/
GET /api/marketplace-maintenance-announcement-offerings/{uuid}/
PATCH /api/marketplace-maintenance-announcement-offerings/{uuid}/
PUT /api/marketplace-maintenance-announcement-offerings/{uuid}/
GET /api/marketplace-maintenance-announcement-template-offerings/
POST /api/marketplace-maintenance-announcement-template-offerings/
DELETE /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
GET /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
PATCH /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
PUT /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
GET /api/marketplace-maintenance-announcements-template/
POST /api/marketplace-maintenance-announcements-template/
DELETE /api/marketplace-maintenance-announcements-template/{uuid}/
GET /api/marketplace-maintenance-announcements-template/{uuid}/
PATCH /api/marketplace-maintenance-announcements-template/{uuid}/
PUT /api/marketplace-maintenance-announcements-template/{uuid}/
GET /api/marketplace-maintenance-announcements/
POST /api/marketplace-maintenance-announcements/
DELETE /api/marketplace-maintenance-announcements/{uuid}/
GET /api/marketplace-maintenance-announcements/{uuid}/
PATCH /api/marketplace-maintenance-announcements/{uuid}/
PUT /api/marketplace-maintenance-announcements/{uuid}/

Deleted Endpoints: None

Modified Endpoints: 268

GET /api/access-subnets/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/admin-announcements/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/auth-tokens/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/autoprovisioning-rule-plans/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/autoprovisioning-rules/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/aws-images/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/aws-instances/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/aws-regions/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/aws-sizes/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/aws-volumes/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-images/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-locations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-public-ips/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-resource-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-sizes/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-sql-databases/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-sql-servers/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/azure-virtualmachines/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/booking-offerings/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/booking-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/booking-resources/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted

GET /api/booking-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

GET /api/broadcast-message-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/broadcast-messages/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/call-managing-organisations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/call-rounds/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/component-user-usage-limits/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/customer-credits/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/customer-permissions-reviews/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/digitalocean-droplets/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/digitalocean-images/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/digitalocean-regions/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/digitalocean-sizes/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/email-logs/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/event-subscriptions/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/events-stats/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/events/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/financial-reports/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/freeipa-profiles/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/google-auth/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/hooks-email/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

GET /api/hooks-web/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]
    • Examples changed
      • Modified example: Webhook-create
      • Value changed from map[destination_url:http://example.com/ event_groups:[users] event_types:[resource_start_succeeded]] to map[destination_url:http://example.com/ event_groups:[users] event_types:[customer_update_succeeded]]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [openstack_security_group_added_remotely openstack_security_group_removed_remotely openstack_security_group_added_locally openstack_security_group_removed_locally]

GET /api/hooks/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/identity-providers/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/invoice-items/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/invoices/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/keycloak-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/keycloak-user-group-memberships/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/keys/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/lexis-links/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-categories/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-category-columns/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-category-component-usages/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-category-components/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-category-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-category-help-articles/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-checklists-categories/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-checklists-categories/{category_uuid}/checklists/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-checklists/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-checklists/{checklist_uuid}/answers/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-checklists/{checklist_uuid}/questions/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-checklists/{checklist_uuid}/user/{user_uuid}/answers/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-component-usages/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-component-user-usages/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-customer-estimated-cost-policies/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-customer-service-accounts/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-integration-statuses/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-offering-estimated-cost-policies/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-offering-files/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-offering-permissions-log/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/marketplace-offering-permissions/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/marketplace-offering-referrals/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-offering-usage-policies/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-offering-user-roles/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-offering-users/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-orders/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: attributes
          • Type changed from 'object' to ''
          • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
          • ReadOnly changed from true to false
          • AdditionalProperties changed
          • Schema deleted

GET /api/marketplace-orders/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: attributes
        • Type changed from 'object' to ''
        • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
        • ReadOnly changed from true to false
        • AdditionalProperties changed
          • Schema deleted

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-plan-components/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-plans/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null

POST /api/marketplace-plans/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/marketplace-plans/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

PATCH /api/marketplace-plans/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

PUT /api/marketplace-plans/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/marketplace-project-estimated-cost-policies/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-project-service-accounts/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-project-update-requests/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-provider-offerings/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-provider-offerings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
      • Modified property: plans
        • Items changed
        • Properties changed
          • Modified property: description
          • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-provider-offerings/groups/

  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-provider-offerings/{uuid}/component_stats/

  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/{uuid}/costs/

  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/marketplace-provider-offerings/{uuid}/customers/

  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: attributes
          • Type changed from 'object' to ''
          • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
          • ReadOnly changed from true to false
          • AdditionalProperties changed
          • Schema deleted

GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: attributes
        • Type changed from 'object' to ''
        • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
        • ReadOnly changed from true to false
        • AdditionalProperties changed
          • Schema deleted

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Description changed from '' to 'Refresh offering user usernames.'
  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plans
        • Items changed
        • Properties changed
          • Modified property: description
          • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: status
      • Properties changed
        • New property: status
        • Deleted property: access_url
        • Deleted property: attributes
        • Deleted property: backend_id
        • Deleted property: backend_metadata
        • Deleted property: billable
        • Deleted property: category
        • Deleted property: category_title
        • Deleted property: category_uuid
        • Deleted property: citation_count
        • Deleted property: components
        • Deleted property: country
        • Deleted property: created
        • Deleted property: customer
        • Deleted property: customer_name
        • Deleted property: customer_uuid
        • Deleted property: datacite_doi
        • Deleted property: description
        • Deleted property: endpoints
        • Deleted property: files
        • Deleted property: full_description
        • Deleted property: getting_started
        • Deleted property: google_calendar_is_public
        • Deleted property: google_calendar_link
        • Deleted property: image
        • Deleted property: integration_guide
        • Deleted property: integration_status
        • Deleted property: latitude
        • Deleted property: longitude
        • Deleted property: name
        • Deleted property: options
        • Deleted property: order_count
        • Deleted property: organization_groups
        • Deleted property: parent_description
        • Deleted property: parent_name
        • Deleted property: parent_uuid
        • Deleted property: paused_reason
        • Deleted property: plans
        • Deleted property: plugin_options
        • Deleted property: privacy_policy_link
        • Deleted property: project
        • Deleted property: project_name
        • Deleted property: project_uuid
        • Deleted property: quotas
        • Deleted property: resource_options
        • Deleted property: roles
        • Deleted property: scope
        • Deleted property: scope_error_message
        • Deleted property: scope_name
        • Deleted property: scope_state
        • Deleted property: scope_uuid
        • Deleted property: screenshots
        • Deleted property: secret_options
        • Deleted property: service_attributes
        • Deleted property: shared
        • Deleted property: slug
        • Deleted property: state
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Deleted property: thumbnail
        • Deleted property: total_cost
        • Deleted property: total_cost_estimated
        • Deleted property: total_customers
        • Deleted property: type
        • Deleted property: url
        • Deleted property: uuid
        • Deleted property: vendor_details

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plugin_options
        • Properties changed
        • New property: minimal_team_count_for_provisioning
        • New property: required_team_role_for_provisioning

POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: uuid
      • Properties changed
      • New property: uuid

POST /api/marketplace-provider-offerings/{uuid}/update_overview/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-provider-resources/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-provider-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-provider-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-provider-resources/{uuid}/set_as_erred/

  • Description changed from '' to 'Set the resource as erred.'
  • Responses changed
  • Modified response: 200
    • Description changed from '' to 'No response body'
    • Content changed
    • Deleted media type: application/json

POST /api/marketplace-provider-resources/{uuid}/set_backend_id/

  • Description changed from '' to 'Set resource backend ID.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: status
      • Properties changed
        • New property: status
        • Deleted property: backend_id

POST /api/marketplace-provider-resources/{uuid}/set_backend_metadata/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: status
        • Deleted required property: backend_metadata
      • Properties changed
        • New property: status
        • Deleted property: backend_metadata

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

POST /api/marketplace-provider-resources/{uuid}/set_limits/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: status
        • Deleted required property: limits
      • Properties changed
        • New property: status
        • Deleted property: limits

POST /api/marketplace-provider-resources/{uuid}/submit_report/

  • Description changed from '' to 'Submit resource report.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: status
        • Deleted required property: report
      • Properties changed
        • New property: status
        • Deleted property: report

GET /api/marketplace-public-offerings/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-public-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-public-offerings/{uuid}/plans/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null

GET /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/marketplace-remote-synchronisations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-resource-users/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-resources/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: attributes
            • Type changed from 'object' to ''
            • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
            • ReadOnly changed from true to false
            • AdditionalProperties changed
              • Schema deleted

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-resources/{uuid}/update_options/

  • Description changed from '' to 'Update resource options.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: status
      • Properties changed
        • New property: status
        • Deleted property: options

GET /api/marketplace-robot-accounts/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offering_plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-screenshots/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-script-async-dry-run/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: description
            • MaxLength changed from 2000 to null
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • New property: minimal_team_count_for_provisioning
            • New property: required_team_role_for_provisioning

GET /api/marketplace-sections/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-service-providers/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/

  • New query param: slug

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null

GET /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/

  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/marketplace-service-providers/{service_provider_uuid}/projects/

  • New query param: slug
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null

GET /api/notification-messages-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/notification-messages/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-backups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-flavors/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • New query param: offering_uuid

GET /api/openstack-images/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • New query param: offering_uuid

GET /api/openstack-instance-availability-zones/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-instances/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-marketplace-tenants/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-migrations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-network-rbac-policies/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-networks/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-ports/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-routers/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-security-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-server-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-snapshots/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-subnets/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-tenants/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-volume-availability-zones/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/openstack-volume-types/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • New query param: offering_uuid

GET /api/openstack-volumes/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/organization-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/override-settings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES
        • New property: MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM

POST /api/override-settings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES
      • New property: MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM

GET /api/payment-profiles/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/payments/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/project-credits/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/project-types/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/projects/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • New query param: slug
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null

POST /api/projects/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

PATCH /api/projects/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

PUT /api/projects/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

POST /api/projects/{uuid}/move_project/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/promotions-campaigns/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/promotions-campaigns/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: attributes
          • Type changed from 'object' to ''
          • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
          • ReadOnly changed from true to false
          • AdditionalProperties changed
          • Schema deleted

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: attributes
              • Type changed from 'object' to ''
              • Description changed from 'Get attributes excluding secret attributes, such as username and password.' to ''
              • ReadOnly changed from true to false
              • AdditionalProperties changed
              • Schema deleted

GET /api/proposal-proposals/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null

POST /api/proposal-proposals/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/proposal-proposals/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null

GET /api/proposal-proposals/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: requested_offering
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
            • Properties changed
            • New property: created
            • Modified property: components
              • Items changed
              • Properties changed
                • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
                • Properties changed
                • Modified property: description
                  • MaxLength changed from 2000 to null

POST /api/proposal-proposals/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-protected-calls/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null
        • Modified property: offerings
          • Items changed
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

POST /api/proposal-protected-calls/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: offerings
        • Items changed
          • Properties changed
          • New property: created
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: factor
              • Nullable changed from false to true
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: offerings
        • Items changed
          • Properties changed
          • New property: created
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: factor
              • Nullable changed from false to true
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: description
                • MaxLength changed from 2000 to null

PATCH /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: offerings
        • Items changed
          • Properties changed
          • New property: created
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: factor
              • Nullable changed from false to true
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: description
                • MaxLength changed from 2000 to null

PUT /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: offerings
        • Items changed
          • Properties changed
          • New property: created
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: factor
              • Nullable changed from false to true
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-protected-calls/{uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: created
        • Properties changed
        • New property: created
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
            • Properties changed
            • Modified property: description
              • MaxLength changed from 2000 to null

POST /api/proposal-protected-calls/{uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: created
      • Properties changed
        • New property: created
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null

GET /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: created
      • Properties changed
        • New property: created
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null

PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: created
      • Properties changed
        • New property: created
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null

PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: created
      • Properties changed
        • New property: created
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: description
        • MaxLength changed from 2000 to null
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: offerings
        • Items changed
          • Properties changed
          • New property: created
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: factor
              • Nullable changed from false to true
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-public-calls/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: description
          • MaxLength changed from 2000 to null
        • Modified property: offerings
          • Items changed
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-public-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: description
        • MaxLength changed from 2000 to null
        • Modified property: offerings
        • Items changed
          • Properties changed
          • New property: created
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: factor
              • Nullable changed from false to true
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-requested-offerings/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: created
        • Properties changed
        • New property: created
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
            • Properties changed
            • Modified property: description
              • MaxLength changed from 2000 to null

GET /api/proposal-requested-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: created
      • Properties changed
        • New property: created
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: factor
            • Nullable changed from false to true
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: description
            • MaxLength changed from 2000 to null

GET /api/proposal-requested-resources/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: requested_offering
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
            • Properties changed
            • New property: created
            • Modified property: components
              • Items changed
              • Properties changed
                • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
                • Properties changed
                • Modified property: description
                  • MaxLength changed from 2000 to null

GET /api/proposal-requested-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • New property: created
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: factor
                • Nullable changed from false to true
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: description
                • MaxLength changed from 2000 to null

GET /api/proposal-reviews/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/provider-invoice-items/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-apps/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-catalogs/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-cluster-security-groups/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-cluster-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-clusters/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-hpas/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-ingresses/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-namespaces/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-nodes/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-projects/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-role-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-services/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-users/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/rancher-workloads/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/roles/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/service-settings/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/slurm-allocation-user-usage/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/slurm-allocations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/slurm-associations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/slurm-jobs/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-attachments/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-comments/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-feedbacks/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-issues/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-priorities/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/support-users/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/user-agreements/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: content

POST /api/user-agreements/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: content
      • Properties changed
      • Modified property: content
        • MinLength changed from 0 to 1
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: content

GET /api/user-agreements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: content

PATCH /api/user-agreements/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: content
        • MinLength changed from 0 to 1
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: content

PUT /api/user-agreements/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: content
      • Properties changed
      • Modified property: content
        • MinLength changed from 0 to 1
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: content

GET /api/user-group-invitations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/user-invitations/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: extra_invitation_text
          • MaxLength changed from null to 250

POST /api/user-invitations/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: extra_invitation_text
        • MaxLength changed from null to 250
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: extra_invitation_text
        • MaxLength changed from null to 250

GET /api/user-invitations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: extra_invitation_text
        • MaxLength changed from null to 250

GET /api/user-permission-requests/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/user-permissions/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'
  • Modified query param: scope_uuid
  • Schema changed
    • Format changed from 'uuid' to ''

GET /api/users/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-clusters/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-datastores/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-disks/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-folders/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-networks/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-ports/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-templates/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

GET /api/vmware-virtual-machine/

  • Description changed from '' to 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing'

OpenAPI schema diff - 7.6.9

For version 7.6.9

New Endpoints: 1

GET /api/openstack-volume-types/names/

Deleted Endpoints: None

Modified Endpoints: 28

GET /api/booking-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
              • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/booking-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/invoices/

  • Deleted query param: max_sum
  • Deleted query param: min_sum

GET /api/invoices/{uuid}/stats/

  • Deleted query param: max_sum
  • Deleted query param: min_sum

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
              • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: plugin_options
        • Properties changed
        • Modified property: managed_rancher_tenant_max_ram
          • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-public-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
              • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-public-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offering_plugin_options
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
            • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
              • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

GET /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offering_plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plugin_options
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MergedPluginOptions
          • Properties changed
            • Modified property: managed_rancher_tenant_max_ram
            • Description changed from 'Max number of RAM for tenants' to 'Max number of RAM for tenants (GB)'

OpenAPI schema diff - 7.7.0

For version 7.7.0

New Endpoints: 8

POST /api/broadcast-messages/{uuid}/schedule/
GET /api/call-proposal-project-role-mappings/
POST /api/call-proposal-project-role-mappings/
DELETE /api/call-proposal-project-role-mappings/{uuid}/
GET /api/call-proposal-project-role-mappings/{uuid}/
PATCH /api/call-proposal-project-role-mappings/{uuid}/
PUT /api/call-proposal-project-role-mappings/{uuid}/
DELETE /api/marketplace-plans/{uuid}/

Deleted Endpoints: 6

GET /api/autoprovisioning-rule-plans/
POST /api/autoprovisioning-rule-plans/
DELETE /api/autoprovisioning-rule-plans/{uuid}/
GET /api/autoprovisioning-rule-plans/{uuid}/
PATCH /api/autoprovisioning-rule-plans/{uuid}/
PUT /api/autoprovisioning-rule-plans/{uuid}/

Modified Endpoints: 36

GET /api/autoprovisioning-rules/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: name
        • New required property: project_role_description
        • New required property: project_role_dispay_name
        • Deleted required property: plans
        • Properties changed
        • New property: customer_name
        • New property: customer_uuid
        • New property: name
        • New property: plan
        • New property: plan_attributes
        • New property: plan_limits
        • New property: project_role_description
        • New property: project_role_dispay_name
        • Deleted property: plans

POST /api/autoprovisioning-rules/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: name
      • Properties changed
      • New property: name
      • New property: plan
      • New property: plan_attributes
      • New property: plan_limits
      • New property: project_role_name
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: name
        • New required property: project_role_description
        • New required property: project_role_dispay_name
        • Deleted required property: plans
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid
        • New property: name
        • New property: plan
        • New property: plan_attributes
        • New property: plan_limits
        • New property: project_role_description
        • New property: project_role_dispay_name
        • Deleted property: plans

GET /api/autoprovisioning-rules/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: name
        • New required property: project_role_description
        • New required property: project_role_dispay_name
        • Deleted required property: plans
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid
        • New property: name
        • New property: plan
        • New property: plan_attributes
        • New property: plan_limits
        • New property: project_role_description
        • New property: project_role_dispay_name
        • Deleted property: plans

PATCH /api/autoprovisioning-rules/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: name
      • New property: plan
      • New property: plan_attributes
      • New property: plan_limits
      • New property: project_role_name
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: name
        • New required property: project_role_description
        • New required property: project_role_dispay_name
        • Deleted required property: plans
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid
        • New property: name
        • New property: plan
        • New property: plan_attributes
        • New property: plan_limits
        • New property: project_role_description
        • New property: project_role_dispay_name
        • Deleted property: plans

PUT /api/autoprovisioning-rules/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Required changed
      • New required property: name
      • Properties changed
      • New property: name
      • New property: plan
      • New property: plan_attributes
      • New property: plan_limits
      • New property: project_role_name
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: customer_name
        • New required property: customer_uuid
        • New required property: name
        • New required property: project_role_description
        • New required property: project_role_dispay_name
        • Deleted required property: plans
      • Properties changed
        • New property: customer_name
        • New property: customer_uuid
        • New property: name
        • New property: plan
        • New property: plan_attributes
        • New property: plan_limits
        • New property: project_role_description
        • New property: project_role_dispay_name
        • Deleted property: plans

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [marketplace_plan_deleted]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_plan_deleted]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_plan_deleted]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_plan_deleted]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [marketplace_plan_deleted]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_plan_deleted]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_plan_deleted]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_plan_deleted]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_plan_deleted]

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: google_calendar_link
          • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-public-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: google_calendar_link
          • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-public-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: google_calendar_link
        • Description changed from '' to 'Get the Google Calendar link for an offering.'

GET /api/proposal-protected-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [default_project_role default_project_role_description default_project_role_name]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: default_project_role
        • Deleted property: default_project_role_description
        • Deleted property: default_project_role_name

POST /api/proposal-protected-calls/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: default_project_role
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: default_project_role
        • Deleted property: default_project_role_description
        • Deleted property: default_project_role_name

GET /api/proposal-protected-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [default_project_role default_project_role_description default_project_role_name]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: default_project_role
        • Deleted property: default_project_role_description
        • Deleted property: default_project_role_name

PATCH /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: default_project_role
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: default_project_role
        • Deleted property: default_project_role_description
        • Deleted property: default_project_role_name

PUT /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: default_project_role
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: default_project_role
        • Deleted property: default_project_role_description
        • Deleted property: default_project_role_name

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: default_project_role
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: default_project_role
        • Deleted property: default_project_role_description
        • Deleted property: default_project_role_name

OpenAPI schema diff - 7.7.1

For version 7.7.1

New Endpoints: None

Deleted Endpoints: None

Modified Endpoints: 18

GET /api/autoprovisioning-rules/

  • Tags changed from 'autoprovisioning-rules' to 'Autoprovisioning Rules'
  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Manage autoprovisioning rules.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: category_title
        • New required property: category_url
        • New required property: offering_name
        • New required property: offering_uuid
        • New required property: plan_name
        • New required property: project_role_display_name
        • Deleted required property: project_role_dispay_name
        • Properties changed
        • New property: category_title
        • New property: category_url
        • New property: offering_name
        • New property: offering_uuid
        • New property: plan_name
        • New property: project_role_display_name
        • Deleted property: project_role_dispay_name

POST /api/autoprovisioning-rules/

  • Tags changed from 'autoprovisioning-rules' to 'Autoprovisioning Rules'
  • Description changed from '' to 'Manage autoprovisioning rules.'
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: category_title
        • New required property: category_url
        • New required property: offering_name
        • New required property: offering_uuid
        • New required property: plan_name
        • New required property: project_role_display_name
        • Deleted required property: project_role_dispay_name
      • Properties changed
        • New property: category_title
        • New property: category_url
        • New property: offering_name
        • New property: offering_uuid
        • New property: plan_name
        • New property: project_role_display_name
        • Deleted property: project_role_dispay_name

DELETE /api/autoprovisioning-rules/{uuid}/

  • Tags changed from 'autoprovisioning-rules' to 'Autoprovisioning Rules'
  • Description changed from '' to 'Manage autoprovisioning rules.'

GET /api/autoprovisioning-rules/{uuid}/

  • Tags changed from 'autoprovisioning-rules' to 'Autoprovisioning Rules'
  • Description changed from '' to 'Manage autoprovisioning rules.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: category_title
        • New required property: category_url
        • New required property: offering_name
        • New required property: offering_uuid
        • New required property: plan_name
        • New required property: project_role_display_name
        • Deleted required property: project_role_dispay_name
      • Properties changed
        • New property: category_title
        • New property: category_url
        • New property: offering_name
        • New property: offering_uuid
        • New property: plan_name
        • New property: project_role_display_name
        • Deleted property: project_role_dispay_name

PATCH /api/autoprovisioning-rules/{uuid}/

  • Tags changed from 'autoprovisioning-rules' to 'Autoprovisioning Rules'
  • Description changed from '' to 'Manage autoprovisioning rules.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: category_title
        • New required property: category_url
        • New required property: offering_name
        • New required property: offering_uuid
        • New required property: plan_name
        • New required property: project_role_display_name
        • Deleted required property: project_role_dispay_name
      • Properties changed
        • New property: category_title
        • New property: category_url
        • New property: offering_name
        • New property: offering_uuid
        • New property: plan_name
        • New property: project_role_display_name
        • Deleted property: project_role_dispay_name

PUT /api/autoprovisioning-rules/{uuid}/

  • Tags changed from 'autoprovisioning-rules' to 'Autoprovisioning Rules'
  • Description changed from '' to 'Manage autoprovisioning rules.'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: category_title
        • New required property: category_url
        • New required property: offering_name
        • New required property: offering_uuid
        • New required property: plan_name
        • New required property: project_role_display_name
        • Deleted required property: project_role_dispay_name
      • Properties changed
        • New property: category_title
        • New property: category_url
        • New property: offering_name
        • New property: offering_uuid
        • New property: plan_name
        • New property: project_role_display_name
        • Deleted property: project_role_dispay_name

GET /api/customers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: default_tax_percent
          • Pattern changed from '^-?\d{0,2}(?:.\d{0,2})?$' to '^-?\d{0,3}(?:.\d{0,2})?$'

POST /api/customers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: default_tax_percent
        • Pattern changed from '^-?\d{0,2}(?:.\d{0,2})?$' to '^-?\d{0,3}(?:.\d{0,2})?$'

GET /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: default_tax_percent
        • Pattern changed from '^-?\d{0,2}(?:.\d{0,2})?$' to '^-?\d{0,3}(?:.\d{0,2})?$'

PATCH /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: default_tax_percent
        • Pattern changed from '^-?\d{0,2}(?:.\d{0,2})?$' to '^-?\d{0,3}(?:.\d{0,2})?$'

PUT /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: default_tax_percent
        • Pattern changed from '^-?\d{0,2}(?:.\d{0,2})?$' to '^-?\d{0,3}(?:.\d{0,2})?$'

GET /api/openstack-floating-ips/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [port_fixed_ips]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: port_fixed_ips

GET /api/openstack-floating-ips/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [port_fixed_ips]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: port_fixed_ips

POST /api/openstack-tenants/{uuid}/create_floating_ip/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: port_fixed_ips

GET /api/user-group-invitations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: project_name_template
          • Nullable changed from false to true

POST /api/user-group-invitations/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: project_name_template
        • Nullable changed from false to true
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: project_name_template
        • Nullable changed from false to true

GET /api/user-group-invitations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: project_name_template
        • Nullable changed from false to true

POST /api/user-group-invitations/{uuid}/submit_request/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: project_name_template
        • Nullable changed from false to true

OpenAPI schema diff - 7.7.2

For version 7.7.2

New Endpoints: 25

GET /api/marketplace-checklists-admin-question-dependencies/
POST /api/marketplace-checklists-admin-question-dependencies/
DELETE /api/marketplace-checklists-admin-question-dependencies/{uuid}/
GET /api/marketplace-checklists-admin-question-dependencies/{uuid}/
PATCH /api/marketplace-checklists-admin-question-dependencies/{uuid}/
PUT /api/marketplace-checklists-admin-question-dependencies/{uuid}/
GET /api/marketplace-checklists-admin-question-options/
POST /api/marketplace-checklists-admin-question-options/
DELETE /api/marketplace-checklists-admin-question-options/{uuid}/
GET /api/marketplace-checklists-admin-question-options/{uuid}/
PATCH /api/marketplace-checklists-admin-question-options/{uuid}/
PUT /api/marketplace-checklists-admin-question-options/{uuid}/
GET /api/marketplace-checklists-admin-questions/
POST /api/marketplace-checklists-admin-questions/
DELETE /api/marketplace-checklists-admin-questions/{uuid}/
GET /api/marketplace-checklists-admin-questions/{uuid}/
PATCH /api/marketplace-checklists-admin-questions/{uuid}/
PUT /api/marketplace-checklists-admin-questions/{uuid}/
GET /api/marketplace-checklists-admin/
POST /api/marketplace-checklists-admin/
DELETE /api/marketplace-checklists-admin/{uuid}/
GET /api/marketplace-checklists-admin/{uuid}/
PATCH /api/marketplace-checklists-admin/{uuid}/
PUT /api/marketplace-checklists-admin/{uuid}/
GET /api/marketplace-checklists-admin/{uuid}/questions/

Deleted Endpoints: None

Modified Endpoints: 41

POST /api/backend-resources/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/booking-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/booking-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-checklists-categories/{category_uuid}/checklists/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: url
        • Properties changed
        • New property: url

GET /api/marketplace-checklists/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: url
        • Properties changed
        • New property: url

GET /api/marketplace-checklists/{checklist_uuid}/

  • Modified path param: checklist_uuid
  • Name changed from 'checklist_uuid' to 'uuid'
  • Schema changed
    • Format changed from '' to 'uuid'
    • Pattern changed from '^[a-f0-9]+$' to ''
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: url
      • Properties changed
        • New property: url

GET /api/marketplace-checklists/{checklist_uuid}/answers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: answer_data
        • Deleted property: value

POST /api/marketplace-checklists/{checklist_uuid}/answers/submit/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Items changed
      • Required changed
        • New required property: answer_data
        • Deleted required property: value
      • Properties changed
        • New property: answer_data
        • Deleted property: value
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: answer_data
        • Deleted required property: value
        • Properties changed
        • New property: answer_data
        • Deleted property: value

GET /api/marketplace-checklists/{checklist_uuid}/questions/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Return questions available for current user.'
  • Modified path param: checklist_uuid
  • Name changed from 'checklist_uuid' to 'uuid'
  • Schema changed
    • Format changed from '' to 'uuid'
    • Pattern changed from '^[a-f0-9]+$' to ''
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: question_options
        • Properties changed
        • New property: question_options
        • Deleted property: correct_answer
        • Modified property: solution
          • Description changed from 'It is shown when incorrect or N/A answer is chosen' to 'Guidance shown when answer needs clarification'

GET /api/marketplace-checklists/{checklist_uuid}/user/{user_uuid}/answers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: answer_data
        • Deleted property: value

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-provider-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-provider-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-provider-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-resources/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/marketplace-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [offering_slug parent_offering_slug]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/openstack-ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Nullable changed from false to true

POST /api/openstack-ports/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Nullable changed from false to true

GET /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Nullable changed from false to true

PATCH /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Nullable changed from false to true

PUT /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Nullable changed from false to true

GET /api/openstack-routers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Nullable changed from false to true

GET /api/openstack-routers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Nullable changed from false to true

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: offering_slug
        • New property: parent_offering_slug

GET /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: resource_templates
          • Items changed
          • Properties changed
            • New property: requested_offering_plan

POST /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • New property: requested_offering_plan

GET /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • New property: requested_offering_plan

PATCH /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • New property: requested_offering_plan

PUT /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • New property: requested_offering_plan

GET /api/proposal-protected-calls/{uuid}/resource_templates/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: requested_offering_plan

POST /api/proposal-protected-calls/{uuid}/resource_templates/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: requested_offering_plan

GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: requested_offering_plan

PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: requested_offering_plan

PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: requested_offering_plan

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • New property: requested_offering_plan

GET /api/proposal-public-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: resource_templates
          • Items changed
          • Properties changed
            • New property: requested_offering_plan

GET /api/proposal-public-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • New property: requested_offering_plan

OpenAPI schema diff - 7.7.3

For version 7.7.3

New Endpoints: 3

POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/
POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/
POST /api/marketplace-offering-users/{uuid}/set_validation_complete/

Deleted Endpoints: None

Modified Endpoints: 39

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [marketplace_offering_user_updated]

POST /api/hooks-email/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_offering_user_updated]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

GET /api/hooks-email/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

PATCH /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_offering_user_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

PUT /api/hooks-email/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_offering_user_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: event_types
          • Items changed
          • New enum values: [marketplace_offering_user_updated]

POST /api/hooks-web/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_offering_user_updated]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

GET /api/hooks-web/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

PATCH /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_offering_user_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

PUT /api/hooks-web/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: event_types
        • Items changed
        • New enum values: [marketplace_offering_user_updated]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: event_types
        • Items changed
          • New enum values: [marketplace_offering_user_updated]

GET /api/marketplace-maintenance-announcement-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: impact_level_display
        • New required property: offering_name
        • Properties changed
        • New property: impact_level_display
        • New property: offering_name

POST /api/marketplace-maintenance-announcement-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: impact_level_display
        • New required property: offering_name
      • Properties changed
        • New property: impact_level_display
        • New property: offering_name

GET /api/marketplace-maintenance-announcement-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: impact_level_display
        • New required property: offering_name
      • Properties changed
        • New property: impact_level_display
        • New property: offering_name

PATCH /api/marketplace-maintenance-announcement-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: impact_level_display
        • New required property: offering_name
      • Properties changed
        • New property: impact_level_display
        • New property: offering_name

PUT /api/marketplace-maintenance-announcement-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: impact_level_display
        • New required property: offering_name
      • Properties changed
        • New property: impact_level_display
        • New property: offering_name

GET /api/marketplace-maintenance-announcements-template/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: affected_offerings
          • Items changed
          • Required changed
            • New required property: impact_level_display
            • New required property: offering_name
          • Properties changed
            • New property: impact_level_display
            • New property: offering_name

POST /api/marketplace-maintenance-announcements-template/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name

GET /api/marketplace-maintenance-announcements-template/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name

PATCH /api/marketplace-maintenance-announcements-template/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name

PUT /api/marketplace-maintenance-announcements-template/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name

GET /api/marketplace-maintenance-announcements/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: service_provider_name
        • Properties changed
        • New property: service_provider_name
        • Modified property: affected_offerings
          • Items changed
          • Required changed
            • New required property: impact_level_display
            • New required property: offering_name
          • Properties changed
            • New property: impact_level_display
            • New property: offering_name
        • Modified property: state
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MaintenanceAnnouncementStateEnum
            • Type changed from 'integer' to 'string'
            • New enum values: [Draft Scheduled In progress Completed Cancelled]
            • Deleted enum values: [1 2 3 4 5]

POST /api/marketplace-maintenance-announcements/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: service_provider_name
      • Properties changed
        • New property: service_provider_name
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MaintenanceAnnouncementStateEnum
          • Type changed from 'integer' to 'string'
          • New enum values: [Draft Scheduled In progress Completed Cancelled]
          • Deleted enum values: [1 2 3 4 5]

GET /api/marketplace-maintenance-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: service_provider_name
      • Properties changed
        • New property: service_provider_name
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MaintenanceAnnouncementStateEnum
          • Type changed from 'integer' to 'string'
          • New enum values: [Draft Scheduled In progress Completed Cancelled]
          • Deleted enum values: [1 2 3 4 5]

PATCH /api/marketplace-maintenance-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: service_provider_name
      • Properties changed
        • New property: service_provider_name
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MaintenanceAnnouncementStateEnum
          • Type changed from 'integer' to 'string'
          • New enum values: [Draft Scheduled In progress Completed Cancelled]
          • Deleted enum values: [1 2 3 4 5]

PUT /api/marketplace-maintenance-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: service_provider_name
      • Properties changed
        • New property: service_provider_name
        • Modified property: affected_offerings
        • Items changed
          • Required changed
          • New required property: impact_level_display
          • New required property: offering_name
          • Properties changed
          • New property: impact_level_display
          • New property: offering_name
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/MaintenanceAnnouncementStateEnum
          • Type changed from 'integer' to 'string'
          • New enum values: [Draft Scheduled In progress Completed Cancelled]
          • Deleted enum values: [1 2 3 4 5]

GET /api/marketplace-offering-users/

  • New query param: state
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_provider_comment state]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: service_provider_comment
        • New property: state

POST /api/marketplace-offering-users/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment
        • New property: state

GET /api/marketplace-offering-users/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_provider_comment state]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment
        • New property: state

PATCH /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment
        • New property: state

PUT /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment
        • New property: state

POST /api/marketplace-service-providers/{uuid}/set_offerings_username/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: username
        • MinLength changed from 1 to 0

GET /api/user-group-invitations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: user_affiliations
        • New property: user_email_patterns
        • Modified property: scope_type
          • Nullable changed from false to true

POST /api/user-group-invitations/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: user_affiliations
      • New property: user_email_patterns
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_affiliations
        • New property: user_email_patterns
        • Modified property: scope_type
        • Nullable changed from false to true

GET /api/user-group-invitations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_affiliations
        • New property: user_email_patterns
        • Modified property: scope_type
        • Nullable changed from false to true

POST /api/user-group-invitations/{uuid}/submit_request/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_affiliations
        • New property: user_email_patterns
        • Modified property: scope_type
        • Nullable changed from false to true

GET /api/user-invitations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: scope_type
          • Nullable changed from false to true

POST /api/user-invitations/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Nullable changed from false to true

GET /api/user-invitations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Nullable changed from false to true

GET /api/user-invitations/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Nullable changed from false to true

OpenAPI schema diff - 7.7.4

For version 7.7.4

New Endpoints: 221

HEAD /api/access-subnets/
HEAD /api/admin-announcements/
HEAD /api/auth-tokens/
HEAD /api/autoprovisioning-rules/
HEAD /api/aws-images/
HEAD /api/aws-instances/
HEAD /api/aws-regions/
HEAD /api/aws-sizes/
HEAD /api/aws-volumes/
HEAD /api/azure-images/
HEAD /api/azure-locations/
HEAD /api/azure-public-ips/
HEAD /api/azure-resource-groups/
HEAD /api/azure-sizes/
HEAD /api/azure-sql-databases/
HEAD /api/azure-sql-servers/
HEAD /api/azure-virtualmachines/
HEAD /api/backend-resource-requests/
HEAD /api/backend-resources/
HEAD /api/booking-offerings/
HEAD /api/booking-resources/
HEAD /api/broadcast-message-templates/
HEAD /api/broadcast-messages/
HEAD /api/broadcast-messages/recipients/
HEAD /api/call-managing-organisations/
HEAD /api/call-proposal-project-role-mappings/
HEAD /api/call-rounds/
HEAD /api/component-user-usage-limits/
HEAD /api/customer-credits/
HEAD /api/customer-permissions-reviews/
HEAD /api/customer-quotas/
HEAD /api/customers/
HEAD /api/customers/countries/
HEAD /api/digitalocean-droplets/
HEAD /api/digitalocean-images/
HEAD /api/digitalocean-regions/
HEAD /api/digitalocean-sizes/
HEAD /api/email-logs/
HEAD /api/event-subscriptions/
HEAD /api/events-stats/
HEAD /api/events/
HEAD /api/events/count/
HEAD /api/events/event_groups/
HEAD /api/events/scope_types/
HEAD /api/financial-reports/
HEAD /api/freeipa-profiles/
HEAD /api/google-auth/
HEAD /api/google-auth/callback/
HEAD /api/hooks-email/
HEAD /api/hooks-web/
HEAD /api/hooks/
HEAD /api/identity-providers/
HEAD /api/invoice-items/
HEAD /api/invoice-items/costs/
HEAD /api/invoice-items/customer_costs_for_period/
HEAD /api/invoice-items/project_costs_for_period/
HEAD /api/invoice-items/total_price/
HEAD /api/invoices/
HEAD /api/invoices/growth/
HEAD /api/keycloak-groups/
HEAD /api/keycloak-user-group-memberships/
HEAD /api/keys/
HEAD /api/lexis-links/
HEAD /api/marketplace-categories/
HEAD /api/marketplace-category-columns/
HEAD /api/marketplace-category-component-usages/
HEAD /api/marketplace-category-components/
HEAD /api/marketplace-category-groups/
HEAD /api/marketplace-category-help-articles/
HEAD /api/marketplace-checklists-admin-question-dependencies/
HEAD /api/marketplace-checklists-admin-question-options/
HEAD /api/marketplace-checklists-admin-questions/
HEAD /api/marketplace-checklists-admin/
HEAD /api/marketplace-checklists/
HEAD /api/marketplace-component-usages/
HEAD /api/marketplace-component-user-usages/
HEAD /api/marketplace-customer-estimated-cost-policies/
HEAD /api/marketplace-customer-estimated-cost-policies/actions/
HEAD /api/marketplace-customer-service-accounts/
HEAD /api/marketplace-integration-statuses/
HEAD /api/marketplace-maintenance-announcement-offerings/
HEAD /api/marketplace-maintenance-announcement-template-offerings/
HEAD /api/marketplace-maintenance-announcements-template/
HEAD /api/marketplace-maintenance-announcements/
HEAD /api/marketplace-offering-estimated-cost-policies/
HEAD /api/marketplace-offering-estimated-cost-policies/actions/
HEAD /api/marketplace-offering-files/
HEAD /api/marketplace-offering-permissions-log/
HEAD /api/marketplace-offering-permissions/
HEAD /api/marketplace-offering-referrals/
HEAD /api/marketplace-offering-usage-policies/
HEAD /api/marketplace-offering-usage-policies/actions/
HEAD /api/marketplace-offering-user-roles/
HEAD /api/marketplace-offering-users/
POST /api/marketplace-offering-users/{uuid}/begin_creating/
POST /api/marketplace-offering-users/{uuid}/set_ok/
HEAD /api/marketplace-orders/
HEAD /api/marketplace-plan-components/
HEAD /api/marketplace-plans/
HEAD /api/marketplace-plans/usage_stats/
HEAD /api/marketplace-project-estimated-cost-policies/
HEAD /api/marketplace-project-estimated-cost-policies/actions/
HEAD /api/marketplace-project-service-accounts/
HEAD /api/marketplace-project-update-requests/
HEAD /api/marketplace-provider-offerings/
HEAD /api/marketplace-provider-offerings/groups/
HEAD /api/marketplace-provider-resources/
HEAD /api/marketplace-public-offerings/
HEAD /api/marketplace-remote-synchronisations/
HEAD /api/marketplace-resource-users/
HEAD /api/marketplace-resources/
HEAD /api/marketplace-robot-accounts/
HEAD /api/marketplace-screenshots/
HEAD /api/marketplace-script-async-dry-run/
HEAD /api/marketplace-sections/
HEAD /api/marketplace-service-providers/
HEAD /api/marketplace-stats/component_usages/
HEAD /api/marketplace-stats/component_usages_per_month/
HEAD /api/marketplace-stats/component_usages_per_project/
HEAD /api/marketplace-stats/count_active_resources_grouped_by_offering/
HEAD /api/marketplace-stats/count_active_resources_grouped_by_offering_country/
HEAD /api/marketplace-stats/count_active_resources_grouped_by_organization_group/
HEAD /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/
HEAD /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/
HEAD /api/marketplace-stats/count_projects_of_service_providers/
HEAD /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/
HEAD /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/
HEAD /api/marketplace-stats/count_users_of_service_providers/
HEAD /api/marketplace-stats/customer_member_count/
HEAD /api/marketplace-stats/offerings_counter_stats/
HEAD /api/marketplace-stats/organization_project_count/
HEAD /api/marketplace-stats/organization_resource_count/
HEAD /api/marketplace-stats/projects_limits_grouped_by_industry_flag/
HEAD /api/marketplace-stats/projects_limits_grouped_by_oecd/
HEAD /api/marketplace-stats/projects_usages_grouped_by_industry_flag/
HEAD /api/marketplace-stats/projects_usages_grouped_by_oecd/
HEAD /api/marketplace-stats/resources_limits/
HEAD /api/marketplace-stats/total_cost_of_active_resources_per_offering/
HEAD /api/notification-messages-templates/
HEAD /api/notification-messages/
HEAD /api/openstack-backups/
HEAD /api/openstack-flavors/
HEAD /api/openstack-flavors/usage_stats/
HEAD /api/openstack-floating-ips/
HEAD /api/openstack-images/
HEAD /api/openstack-images/usage_stats/
HEAD /api/openstack-instance-availability-zones/
HEAD /api/openstack-instances/
HEAD /api/openstack-marketplace-tenants/
HEAD /api/openstack-migrations/
HEAD /api/openstack-network-rbac-policies/
HEAD /api/openstack-networks/
HEAD /api/openstack-ports/
HEAD /api/openstack-routers/
HEAD /api/openstack-security-groups/
HEAD /api/openstack-server-groups/
HEAD /api/openstack-snapshots/
HEAD /api/openstack-subnets/
HEAD /api/openstack-tenants/
HEAD /api/openstack-volume-availability-zones/
HEAD /api/openstack-volume-types/
HEAD /api/openstack-volume-types/names/
HEAD /api/openstack-volumes/
HEAD /api/organization-groups/
HEAD /api/payment-profiles/
HEAD /api/payments/
HEAD /api/project-credits/
HEAD /api/project-quotas/
HEAD /api/project-types/
HEAD /api/projects/
HEAD /api/promotions-campaigns/
HEAD /api/proposal-proposals/
HEAD /api/proposal-protected-calls/
HEAD /api/proposal-public-calls/
HEAD /api/proposal-requested-offerings/
HEAD /api/proposal-requested-resources/
HEAD /api/proposal-reviews/
HEAD /api/provider-invoice-items/
HEAD /api/rancher-apps/
HEAD /api/rancher-catalogs/
HEAD /api/rancher-cluster-security-groups/
HEAD /api/rancher-cluster-templates/
HEAD /api/rancher-clusters/
HEAD /api/rancher-hpas/
HEAD /api/rancher-ingresses/
HEAD /api/rancher-namespaces/
HEAD /api/rancher-nodes/
HEAD /api/rancher-projects/
HEAD /api/rancher-role-templates/
HEAD /api/rancher-services/
HEAD /api/rancher-templates/
HEAD /api/rancher-users/
HEAD /api/rancher-workloads/
HEAD /api/roles/
HEAD /api/service-settings/
HEAD /api/slurm-allocation-user-usage/
HEAD /api/slurm-allocations/
HEAD /api/slurm-associations/
HEAD /api/slurm-jobs/
HEAD /api/support-attachments/
HEAD /api/support-comments/
HEAD /api/support-feedbacks/
HEAD /api/support-issues/
HEAD /api/support-priorities/
HEAD /api/support-templates/
HEAD /api/support-users/
HEAD /api/user-agreements/
HEAD /api/user-group-invitations/
HEAD /api/user-invitations/
HEAD /api/user-permission-requests/
HEAD /api/user-permissions/
HEAD /api/users/
HEAD /api/users/me/
HEAD /api/vmware-clusters/
HEAD /api/vmware-datastores/
HEAD /api/vmware-disks/
HEAD /api/vmware-folders/
HEAD /api/vmware-networks/
HEAD /api/vmware-ports/
HEAD /api/vmware-templates/
HEAD /api/vmware-virtual-machine/

Deleted Endpoints: None

Modified Endpoints: 371

GET /api-auth/saml2/providers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/access-subnets/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/access-subnets/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PATCH /api/access-subnets/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/access-subnets/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/admin-announcements/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/auth-tokens/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/autoprovisioning-rules/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/aws-images/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/aws-instances/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/aws-regions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/aws-sizes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/aws-volumes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-images/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-locations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-public-ips/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-resource-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-sizes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-sql-databases/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-sql-servers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/azure-virtualmachines/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/backend-resource-requests/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: uuid
        • Properties changed
        • New property: uuid
    • Headers changed
    • New header: x-result-count

POST /api/backend-resource-requests/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: uuid
      • Properties changed
        • New property: uuid

GET /api/backend-resource-requests/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: uuid
      • Properties changed
        • New property: uuid

POST /api/backend-resource-requests/{uuid}/set_done/

  • Extensions changed
  • New extension: x-permissions

POST /api/backend-resource-requests/{uuid}/set_erred/

  • Extensions changed
  • New extension: x-permissions

POST /api/backend-resource-requests/{uuid}/start_processing/

  • Extensions changed
  • New extension: x-permissions

GET /api/backend-resources/

  • Extensions changed
  • New extension: x-permissions
  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/backend-resources/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/backend-resources/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/booking-offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/booking-resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/booking-resources/{uuid}/accept/

  • Extensions changed
  • New extension: x-permissions

GET /api/broadcast-message-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/broadcast-messages/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/call-managing-organisations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/call-managing-organisations/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/call-proposal-project-role-mappings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/call-rounds/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/call-rounds/{uuid}/reviewers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/component-user-usage-limits/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/component-user-usage-limits/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PATCH /api/component-user-usage-limits/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/component-user-usage-limits/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/customer-credits/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customer-credits/{uuid}/consumptions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customer-permissions-reviews/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customer-quotas/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customers/countries/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customers/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/customers/{uuid}/users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/database-stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/digitalocean-droplets/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/digitalocean-images/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/digitalocean-regions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/digitalocean-sizes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/email-logs/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/event-subscriptions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/events-stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/events/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/financial-reports/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/freeipa-profiles/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/google-auth/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/hooks-email/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/hooks-web/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/identity-providers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/invoice-items/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/invoice-items/costs/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/invoices/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/invoices/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/keycloak-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/keycloak-user-group-memberships/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/keys/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/lexis-links/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/lexis-links/

  • Extensions changed
  • New extension: x-permissions

DELETE /api/lexis-links/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-bookings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-categories/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-category-columns/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-category-component-usages/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-category-components/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-category-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-category-help-articles/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists-admin-question-dependencies/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists-admin-question-options/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists-admin-questions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists-admin/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists-categories/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists-categories/{category_uuid}/checklists/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists/{checklist_uuid}/answers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists/{checklist_uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists/{checklist_uuid}/user/{user_uuid}/answers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-checklists/{uuid}/questions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-component-usages/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-component-usages/{uuid}/set_user_usage/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-component-user-usages/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-customer-estimated-cost-policies/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-customer-service-accounts/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/marketplace-customer-service-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PATCH /api/marketplace-customer-service-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/marketplace-customer-service-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-integration-statuses/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-maintenance-announcement-offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-maintenance-announcement-template-offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-maintenance-announcements-template/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-maintenance-announcements/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-estimated-cost-policies/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-files/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-permissions-log/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-permissions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-referrals/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-usage-policies/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-user-roles/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-offering-users/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_email]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: user_email
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-offering-users/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_email

GET /api/marketplace-offering-users/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_email]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_email

PATCH /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_email

PUT /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_email

POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-offering-users/{uuid}/set_validation_complete/

  • Extensions changed
  • New extension: x-permissions
  • Request body changed

GET /api/marketplace-orders/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/marketplace-orders/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/approve_by_consumer/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/approve_by_provider/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/cancel/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/reject_by_provider/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/set_state_done/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/set_state_erred/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-orders/{uuid}/set_state_executing/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-plan-components/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-plans/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-plans/usage_stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

PATCH /api/marketplace-plans/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/marketplace-plans/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-plans/{uuid}/archive/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-plans/{uuid}/delete_organization_groups/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-plans/{uuid}/update_organization_groups/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-plans/{uuid}/update_prices/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-plans/{uuid}/update_quotas/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-plugins/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-project-estimated-cost-policies/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-project-service-accounts/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/marketplace-project-service-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PATCH /api/marketplace-project-service-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/marketplace-project-service-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-project-update-requests/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/marketplace-provider-offerings/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/add_endpoint/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/archive/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-provider-offerings/{uuid}/component_stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/{uuid}/costs/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-provider-offerings/{uuid}/create_offering_component/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-provider-offerings/{uuid}/customers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-provider-offerings/{uuid}/delete_endpoint/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-provider-offerings/{uuid}/importable_resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/{uuid}/list_customer_users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: permissions
          • Items changed
          • Properties changed
            • Modified property: scope_type
            • Nullable changed from false to true
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-provider-offerings/{uuid}/pause/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/remove_offering_component/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/sync/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/unpause/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_attributes/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_description/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_integration/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_location/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_options/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-offerings/{uuid}/update_resource_options/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-provider-resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-resources/{uuid}/offering_for_subresources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-provider-resources/{uuid}/plan_periods/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-resources/{uuid}/set_as_erred/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-resources/{uuid}/set_backend_id/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-resources/{uuid}/set_backend_metadata/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-provider-resources/{uuid}/submit_report/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-provider-resources/{uuid}/team/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-provider-resources/{uuid}/terminate/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-public-offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-public-offerings/{uuid}/plans/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-related-customers/{customer_uuid}/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-remote-synchronisations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-resource-offerings/{category_uuid}/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-resource-users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-resources/{uuid}/offering_for_subresources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-resources/{uuid}/plan_periods/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-resources/{uuid}/switch_plan/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-resources/{uuid}/team/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-resources/{uuid}/terminate/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-resources/{uuid}/update_limits/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-resources/{uuid}/update_options/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/marketplace-robot-accounts/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-runtime-states/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-screenshots/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/marketplace-screenshots/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-script-async-dry-run/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Extensions changed
  • New extension: x-permissions

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-sections/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/customers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/keys/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/projects/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/user_customers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{service_provider_uuid}/users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{uuid}/revenue/

  • Extensions changed
  • New extension: x-permissions
  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{uuid}/robot_account_customers/

  • Extensions changed
  • New extension: x-permissions
  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-service-providers/{uuid}/robot_account_projects/

  • Extensions changed
  • New extension: x-permissions
  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/marketplace-service-providers/{uuid}/set_offerings_username/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-service-providers/{uuid}/stat/

  • Extensions changed
  • New extension: x-permissions

GET /api/marketplace-stats/component_usages/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/component_usages_per_month/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/component_usages_per_project/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_active_resources_grouped_by_offering/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_active_resources_grouped_by_offering_country/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_active_resources_grouped_by_organization_group/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_projects_of_service_providers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/count_users_of_service_providers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/customer_member_count/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/offerings_counter_stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/organization_project_count/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/organization_resource_count/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/resources_limits/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/marketplace-stats/total_cost_of_active_resources_per_offering/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/notification-messages-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/notification-messages/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-flavors/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-floating-ips/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-images/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-instance-availability-zones/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-instances/{uuid}/floating_ips/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-instances/{uuid}/ports/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-marketplace-tenants/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-migrations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-network-rbac-policies/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-networks/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-ports/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-routers/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-security-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-server-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-snapshots/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-snapshots/{uuid}/restorations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-subnets/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-tenants/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-tenants/{uuid}/backend_instances/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-tenants/{uuid}/backend_volumes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-volume-availability-zones/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-volume-types/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/openstack-volumes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/organization-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/payment-profiles/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/payments/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/project-credits/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/project-quotas/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/project-types/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/projects/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/projects/{project_uuid}/marketplace-checklists/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/projects/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PATCH /api/projects/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/projects/{uuid}/

  • Extensions changed
  • New extension: x-permissions

GET /api/projects/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/projects/{uuid}/other_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/promotions-campaigns/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

DELETE /api/promotions-campaigns/{uuid}/

  • Extensions changed
  • New extension: x-permissions

PUT /api/promotions-campaigns/{uuid}/

  • Extensions changed
  • New extension: x-permissions

POST /api/promotions-campaigns/{uuid}/activate/

  • Extensions changed
  • New extension: x-permissions

GET /api/promotions-campaigns/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/promotions-campaigns/{uuid}/terminate/

  • Extensions changed
  • New extension: x-permissions

GET /api/proposal-proposals/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/proposal-proposals/{uuid}/approve/

  • Extensions changed
  • New extension: x-permissions

GET /api/proposal-proposals/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/proposal-proposals/{uuid}/reject/

  • Extensions changed
  • New extension: x-permissions

GET /api/proposal-proposals/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/proposal-protected-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [manager_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: manager_uuid
    • Headers changed
    • New header: x-result-count

POST /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: manager_uuid

GET /api/proposal-protected-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [manager_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: manager_uuid

PATCH /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: manager_uuid

PUT /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: manager_uuid

GET /api/proposal-protected-calls/{uuid}/list_users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/proposal-protected-calls/{uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/proposal-protected-calls/{uuid}/resource_templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/proposal-protected-calls/{uuid}/rounds/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: manager_uuid

GET /api/proposal-public-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [manager_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: manager_uuid
    • Headers changed
    • New header: x-result-count

GET /api/proposal-public-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [manager_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: manager_uuid

GET /api/proposal-requested-offerings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

POST /api/proposal-requested-offerings/{uuid}/accept/

  • Extensions changed
  • New extension: x-permissions

POST /api/proposal-requested-offerings/{uuid}/cancel/

  • Extensions changed
  • New extension: x-permissions

GET /api/proposal-requested-resources/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/proposal-reviews/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/provider-invoice-items/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rabbitmq-user-stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rabbitmq-vhost-stats/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-apps/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-catalogs/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-cluster-security-groups/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-cluster-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-clusters/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-hpas/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-ingresses/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-namespaces/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-nodes/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-projects/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-role-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-services/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/rancher-workloads/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/roles/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/service-settings/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/slurm-allocation-user-usage/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/slurm-allocations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/slurm-associations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/slurm-jobs/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-attachments/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-comments/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-feedbacks/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-issues/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-priorities/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/support-users/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/user-agreements/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/user-group-invitations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/user-group-invitations/{uuid}/projects/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/user-invitations/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/user-permission-requests/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/user-permissions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: scope_type
          • Nullable changed from false to true
    • Headers changed
    • New header: x-result-count

GET /api/user-permissions/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: scope_type
        • Nullable changed from false to true

GET /api/users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: permissions
          • Items changed
          • Properties changed
            • Modified property: scope_type
            • Nullable changed from false to true
    • Headers changed
    • New header: x-result-count

POST /api/users/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: permissions
        • Items changed
          • Properties changed
          • Modified property: scope_type
            • Nullable changed from false to true

GET /api/users/me/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: permissions
        • Items changed
          • Properties changed
          • Modified property: scope_type
            • Nullable changed from false to true

GET /api/users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: permissions
        • Items changed
          • Properties changed
          • Modified property: scope_type
            • Nullable changed from false to true

PATCH /api/users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: permissions
        • Items changed
          • Properties changed
          • Modified property: scope_type
            • Nullable changed from false to true

PUT /api/users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: permissions
        • Items changed
          • Properties changed
          • Modified property: scope_type
            • Nullable changed from false to true

GET /api/vmware-clusters/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-datastores/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-disks/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-folders/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-networks/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-ports/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-templates/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

GET /api/vmware-virtual-machine/

  • Responses changed
  • Modified response: 200
    • Headers changed
    • New header: x-result-count

OpenAPI schema diff - 7.7.5

For version 7.7.5

New Endpoints: 95

GET /api/checklists-admin-categories/
HEAD /api/checklists-admin-categories/
POST /api/checklists-admin-categories/
DELETE /api/checklists-admin-categories/{uuid}/
GET /api/checklists-admin-categories/{uuid}/
PATCH /api/checklists-admin-categories/{uuid}/
PUT /api/checklists-admin-categories/{uuid}/
GET /api/checklists-admin-question-dependencies/
HEAD /api/checklists-admin-question-dependencies/
POST /api/checklists-admin-question-dependencies/
DELETE /api/checklists-admin-question-dependencies/{uuid}/
GET /api/checklists-admin-question-dependencies/{uuid}/
PATCH /api/checklists-admin-question-dependencies/{uuid}/
PUT /api/checklists-admin-question-dependencies/{uuid}/
GET /api/checklists-admin-question-options/
HEAD /api/checklists-admin-question-options/
POST /api/checklists-admin-question-options/
DELETE /api/checklists-admin-question-options/{uuid}/
GET /api/checklists-admin-question-options/{uuid}/
PATCH /api/checklists-admin-question-options/{uuid}/
PUT /api/checklists-admin-question-options/{uuid}/
GET /api/checklists-admin-questions/
HEAD /api/checklists-admin-questions/
POST /api/checklists-admin-questions/
DELETE /api/checklists-admin-questions/{uuid}/
GET /api/checklists-admin-questions/{uuid}/
PATCH /api/checklists-admin-questions/{uuid}/
PUT /api/checklists-admin-questions/{uuid}/
GET /api/checklists-admin/
HEAD /api/checklists-admin/
POST /api/checklists-admin/
DELETE /api/checklists-admin/{uuid}/
GET /api/checklists-admin/{uuid}/
PATCH /api/checklists-admin/{uuid}/
PUT /api/checklists-admin/{uuid}/
GET /api/checklists-admin/{uuid}/questions/
GET /api/external-links/
HEAD /api/external-links/
POST /api/external-links/
DELETE /api/external-links/{uuid}/
GET /api/external-links/{uuid}/
PATCH /api/external-links/{uuid}/
PUT /api/external-links/{uuid}/
GET /api/maintenance-announcement-offerings/
HEAD /api/maintenance-announcement-offerings/
POST /api/maintenance-announcement-offerings/
DELETE /api/maintenance-announcement-offerings/{uuid}/
GET /api/maintenance-announcement-offerings/{uuid}/
PATCH /api/maintenance-announcement-offerings/{uuid}/
PUT /api/maintenance-announcement-offerings/{uuid}/
GET /api/maintenance-announcement-template-offerings/
HEAD /api/maintenance-announcement-template-offerings/
POST /api/maintenance-announcement-template-offerings/
DELETE /api/maintenance-announcement-template-offerings/{uuid}/
GET /api/maintenance-announcement-template-offerings/{uuid}/
PATCH /api/maintenance-announcement-template-offerings/{uuid}/
PUT /api/maintenance-announcement-template-offerings/{uuid}/
GET /api/maintenance-announcements-template/
HEAD /api/maintenance-announcements-template/
POST /api/maintenance-announcements-template/
DELETE /api/maintenance-announcements-template/{uuid}/
GET /api/maintenance-announcements-template/{uuid}/
PATCH /api/maintenance-announcements-template/{uuid}/
PUT /api/maintenance-announcements-template/{uuid}/
GET /api/maintenance-announcements/
HEAD /api/maintenance-announcements/
POST /api/maintenance-announcements/
DELETE /api/maintenance-announcements/{uuid}/
GET /api/maintenance-announcements/{uuid}/
PATCH /api/maintenance-announcements/{uuid}/
PUT /api/maintenance-announcements/{uuid}/
POST /api/maintenance-announcements/{uuid}/cancel_maintenance/
POST /api/maintenance-announcements/{uuid}/complete_maintenance/
POST /api/maintenance-announcements/{uuid}/schedule/
POST /api/maintenance-announcements/{uuid}/start_maintenance/
POST /api/maintenance-announcements/{uuid}/unschedule/
POST /api/marketplace-offering-users/{uuid}/request_deletion/
POST /api/marketplace-offering-users/{uuid}/set_deleted/
POST /api/marketplace-offering-users/{uuid}/set_deleting/
POST /api/marketplace-offering-users/{uuid}/set_error_creating/
POST /api/marketplace-offering-users/{uuid}/set_error_deleting/
PATCH /api/marketplace-offering-users/{uuid}/update_comments/
POST /api/marketplace-provider-resources/{uuid}/pull/
POST /api/marketplace-resources/{uuid}/pull/
GET /api/projects/{uuid}/checklist/
GET /api/projects/{uuid}/completion_status/
POST /api/projects/{uuid}/submit_answers/
GET /api/proposal-proposals/{uuid}/checklist/
GET /api/proposal-proposals/{uuid}/checklist_review/
GET /api/proposal-proposals/{uuid}/completion_review_status/
GET /api/proposal-proposals/{uuid}/completion_status/
POST /api/proposal-proposals/{uuid}/submit_answers/
GET /api/proposal-protected-calls/{uuid}/compliance_overview/
GET /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/
POST /api/proposal-protected-calls/{uuid}/review_proposal_compliance/

Deleted Endpoints: 73

GET /api/customers/{customer_uuid}/marketplace-checklists/
POST /api/customers/{customer_uuid}/marketplace-checklists/
GET /api/customers/{customer_uuid}/marketplace-checklists/{checklist_uuid}/
GET /api/marketplace-checklists-admin-question-dependencies/
HEAD /api/marketplace-checklists-admin-question-dependencies/
POST /api/marketplace-checklists-admin-question-dependencies/
DELETE /api/marketplace-checklists-admin-question-dependencies/{uuid}/
GET /api/marketplace-checklists-admin-question-dependencies/{uuid}/
PATCH /api/marketplace-checklists-admin-question-dependencies/{uuid}/
PUT /api/marketplace-checklists-admin-question-dependencies/{uuid}/
GET /api/marketplace-checklists-admin-question-options/
HEAD /api/marketplace-checklists-admin-question-options/
POST /api/marketplace-checklists-admin-question-options/
DELETE /api/marketplace-checklists-admin-question-options/{uuid}/
GET /api/marketplace-checklists-admin-question-options/{uuid}/
PATCH /api/marketplace-checklists-admin-question-options/{uuid}/
PUT /api/marketplace-checklists-admin-question-options/{uuid}/
GET /api/marketplace-checklists-admin-questions/
HEAD /api/marketplace-checklists-admin-questions/
POST /api/marketplace-checklists-admin-questions/
DELETE /api/marketplace-checklists-admin-questions/{uuid}/
GET /api/marketplace-checklists-admin-questions/{uuid}/
PATCH /api/marketplace-checklists-admin-questions/{uuid}/
PUT /api/marketplace-checklists-admin-questions/{uuid}/
GET /api/marketplace-checklists-admin/
HEAD /api/marketplace-checklists-admin/
POST /api/marketplace-checklists-admin/
DELETE /api/marketplace-checklists-admin/{uuid}/
GET /api/marketplace-checklists-admin/{uuid}/
PATCH /api/marketplace-checklists-admin/{uuid}/
PUT /api/marketplace-checklists-admin/{uuid}/
GET /api/marketplace-checklists-admin/{uuid}/questions/
GET /api/marketplace-checklists-categories/
GET /api/marketplace-checklists-categories/{category_uuid}/checklists/
GET /api/marketplace-checklists-categories/{uuid}/
GET /api/marketplace-checklists/
HEAD /api/marketplace-checklists/
GET /api/marketplace-checklists/{checklist_uuid}/answers/
POST /api/marketplace-checklists/{checklist_uuid}/answers/submit/
GET /api/marketplace-checklists/{checklist_uuid}/stats/
GET /api/marketplace-checklists/{checklist_uuid}/user/{user_uuid}/answers/
GET /api/marketplace-checklists/{uuid}/
GET /api/marketplace-checklists/{uuid}/questions/
GET /api/marketplace-maintenance-announcement-offerings/
HEAD /api/marketplace-maintenance-announcement-offerings/
POST /api/marketplace-maintenance-announcement-offerings/
DELETE /api/marketplace-maintenance-announcement-offerings/{uuid}/
GET /api/marketplace-maintenance-announcement-offerings/{uuid}/
PATCH /api/marketplace-maintenance-announcement-offerings/{uuid}/
PUT /api/marketplace-maintenance-announcement-offerings/{uuid}/
GET /api/marketplace-maintenance-announcement-template-offerings/
HEAD /api/marketplace-maintenance-announcement-template-offerings/
POST /api/marketplace-maintenance-announcement-template-offerings/
DELETE /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
GET /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
PATCH /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
PUT /api/marketplace-maintenance-announcement-template-offerings/{uuid}/
GET /api/marketplace-maintenance-announcements-template/
HEAD /api/marketplace-maintenance-announcements-template/
POST /api/marketplace-maintenance-announcements-template/
DELETE /api/marketplace-maintenance-announcements-template/{uuid}/
GET /api/marketplace-maintenance-announcements-template/{uuid}/
PATCH /api/marketplace-maintenance-announcements-template/{uuid}/
PUT /api/marketplace-maintenance-announcements-template/{uuid}/
GET /api/marketplace-maintenance-announcements/
HEAD /api/marketplace-maintenance-announcements/
POST /api/marketplace-maintenance-announcements/
DELETE /api/marketplace-maintenance-announcements/{uuid}/
GET /api/marketplace-maintenance-announcements/{uuid}/
PATCH /api/marketplace-maintenance-announcements/{uuid}/
PUT /api/marketplace-maintenance-announcements/{uuid}/
GET /api/projects/{project_uuid}/marketplace-checklists/
GET /api/users/{user_uuid}/marketplace-checklist-stats/

Modified Endpoints: 337

HEAD /api/access-subnets/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'access_subnets_head' to 'access_subnets_count'

HEAD /api/admin-announcements/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'admin_announcements_head' to 'admin_announcements_count'

HEAD /api/auth-tokens/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'auth_tokens_head' to 'auth_tokens_count'

HEAD /api/autoprovisioning-rules/

  • Description changed from 'Manage autoprovisioning rules.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'autoprovisioning_rules_head' to 'autoprovisioning_rules_count'

HEAD /api/aws-images/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'aws_images_head' to 'aws_images_count'

HEAD /api/aws-instances/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'aws_instances_head' to 'aws_instances_count'

HEAD /api/aws-regions/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'aws_regions_head' to 'aws_regions_count'

HEAD /api/aws-sizes/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'aws_sizes_head' to 'aws_sizes_count'

HEAD /api/aws-volumes/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'aws_volumes_head' to 'aws_volumes_count'

HEAD /api/azure-images/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_images_head' to 'azure_images_count'

HEAD /api/azure-locations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_locations_head' to 'azure_locations_count'

HEAD /api/azure-public-ips/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_public_ips_head' to 'azure_public_ips_count'

HEAD /api/azure-resource-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_resource_groups_head' to 'azure_resource_groups_count'

HEAD /api/azure-sizes/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_sizes_head' to 'azure_sizes_count'

HEAD /api/azure-sql-databases/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_sql_databases_head' to 'azure_sql_databases_count'

HEAD /api/azure-sql-servers/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_sql_servers_head' to 'azure_sql_servers_count'

HEAD /api/azure-virtualmachines/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'azure_virtualmachines_head' to 'azure_virtualmachines_count'

GET /api/backend-resource-requests/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: error_message
        • New required property: error_traceback
        • Properties changed
        • New property: error_message
        • New property: error_traceback

HEAD /api/backend-resource-requests/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'backend_resource_requests_head' to 'backend_resource_requests_count'

POST /api/backend-resource-requests/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: error_message
        • New required property: error_traceback
      • Properties changed
        • New property: error_message
        • New property: error_traceback

GET /api/backend-resource-requests/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: error_message
        • New required property: error_traceback
      • Properties changed
        • New property: error_message
        • New property: error_traceback

HEAD /api/backend-resources/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'backend_resources_head' to 'backend_resources_count'

POST /api/backend-resources/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/booking-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: limit_period
            • Property 'OneOf' changed
              • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

HEAD /api/booking-offerings/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'booking_offerings_head' to 'booking_offerings_count'

GET /api/booking-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/booking-resources/

  • Modified query param: query
  • Description changed from 'Query' to 'Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

HEAD /api/booking-resources/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'booking_resources_head' to 'booking_resources_count'
  • Modified query param: query
  • Description changed from 'Query' to 'Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor'

GET /api/booking-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

HEAD /api/broadcast-message-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'broadcast_message_templates_head' to 'broadcast_message_templates_count'

HEAD /api/broadcast-messages/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'broadcast_messages_head' to 'broadcast_messages_count'

HEAD /api/broadcast-messages/recipients/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'broadcast_messages_recipients_head' to 'broadcast_messages_recipients_count'

HEAD /api/call-managing-organisations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'call_managing_organisations_head' to 'call_managing_organisations_count'

HEAD /api/call-proposal-project-role-mappings/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'call_proposal_project_role_mappings_head' to 'call_proposal_project_role_mappings_count'

HEAD /api/call-rounds/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'call_rounds_head' to 'call_rounds_count'

HEAD /api/component-user-usage-limits/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'component_user_usage_limits_head' to 'component_user_usage_limits_count'

HEAD /api/customer-credits/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'customer_credits_head' to 'customer_credits_count'

HEAD /api/customer-permissions-reviews/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'customer_permissions_reviews_head' to 'customer_permissions_reviews_count'

HEAD /api/customer-quotas/

  • Description changed from 'List customer quotas.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'customer_quotas_head' to 'customer_quotas_count'

GET /api/customers/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

HEAD /api/customers/

  • Description changed from 'To get a list of customers, run GET against /api/customers/ as authenticated user. Note that a user can only see connected customers:

  • customers that the user owns

  • customers that have a project where user has a role

Staff also can filter customers by user UUID, for example /api/customers/?user_uuid=

Staff also can filter customers by exists accounting_start_date, for example:

The first category: /api/customers/?accounting_is_running=True has accounting_start_date empty (i.e. accounting starts at once) has accounting_start_date in the past (i.e. has already started).

Those that are not in the first: /api/customers/?accounting_is_running=False # exists accounting_start_date' to 'Get number of items in the collection matching the request parameters.'

  • OperationID changed from 'customers_head' to 'customers_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

GET /api/customers/countries/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

HEAD /api/customers/countries/

  • Description changed from 'Return list of countries' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'customers_countries_head' to 'customers_countries_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

HEAD /api/digitalocean-droplets/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'digitalocean_droplets_head' to 'digitalocean_droplets_count'

HEAD /api/digitalocean-images/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'digitalocean_images_head' to 'digitalocean_images_count'

HEAD /api/digitalocean-regions/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'digitalocean_regions_head' to 'digitalocean_regions_count'

HEAD /api/digitalocean-sizes/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'digitalocean_sizes_head' to 'digitalocean_sizes_count'

HEAD /api/email-logs/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'email_logs_head' to 'email_logs_count'

HEAD /api/event-subscriptions/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'event_subscriptions_head' to 'event_subscriptions_count'

HEAD /api/events-stats/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'events_stats_head' to 'events_stats_count'

HEAD /api/events/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'events_head' to 'events_count'

HEAD /api/events/count/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'events_count_head' to 'events_count_count'

HEAD /api/events/event_groups/

  • Description changed from 'Returns a list of groups with event types. Group is used in exclude_features query param.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'events_event_groups_head' to 'events_event_groups_count'

HEAD /api/events/scope_types/

  • Description changed from 'Returns a list of scope types acceptable by events filter.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'events_scope_types_head' to 'events_scope_types_count'

GET /api/financial-reports/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

HEAD /api/financial-reports/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'financial_reports_head' to 'financial_reports_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

GET /api/freeipa-profiles/

  • Modified query param: query
  • Description changed from '' to 'Filter by username, user UUID, first name or last name'

HEAD /api/freeipa-profiles/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'freeipa_profiles_head' to 'freeipa_profiles_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by username, user UUID, first name or last name'

HEAD /api/google-auth/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'google_auth_head' to 'google_auth_count'

HEAD /api/google-auth/callback/

  • Description changed from 'Callback endpoint for Google authorization.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'google_auth_callback_head' to 'google_auth_callback_count'

GET /api/hooks-email/

  • Modified query param: query
  • Description changed from '' to 'Filter by author name, username and email'

HEAD /api/hooks-email/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'hooks_email_head' to 'hooks_email_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by author name, username and email'

GET /api/hooks-web/

  • Modified query param: query
  • Description changed from '' to 'Filter by author name, username and email'

HEAD /api/hooks-web/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'hooks_web_head' to 'hooks_web_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by author name, username and email'

HEAD /api/hooks/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'hooks_head' to 'hooks_count'

HEAD /api/identity-providers/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'identity_providers_head' to 'identity_providers_count'

GET /api/invoice-items/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: unit
          • New enum values: [quarter]

HEAD /api/invoice-items/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoice_items_head' to 'invoice_items_count'

HEAD /api/invoice-items/costs/

  • Description changed from 'Get costs breakdown for a project by year and month.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoice_items_costs_head' to 'invoice_items_costs_count'

HEAD /api/invoice-items/customer_costs_for_period/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoice_items_customer_costs_for_period_head' to 'invoice_items_customer_costs_for_period_count'

HEAD /api/invoice-items/project_costs_for_period/

  • Description changed from 'Get resource cost breakdown for a project over a specified period.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoice_items_project_costs_for_period_head' to 'invoice_items_project_costs_for_period_count'

HEAD /api/invoice-items/total_price/

  • Description changed from 'Calculate total price for filtered invoice items.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoice_items_total_price_head' to 'invoice_items_total_price_count'

GET /api/invoice-items/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

GET /api/invoice-items/{uuid}/consumptions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

GET /api/invoices/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: items
          • Items changed
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

HEAD /api/invoices/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoices_head' to 'invoices_count'

HEAD /api/invoices/growth/

  • Description changed from 'Analyze invoice trends over time by comparing monthly totals for major customers versus others over the past year.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'invoices_growth_head' to 'invoices_growth_count'

GET /api/invoices/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: items
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/invoices/{uuid}/items/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

POST /api/invoices/{uuid}/paid/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: items
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

HEAD /api/keycloak-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'keycloak_groups_head' to 'keycloak_groups_count'

HEAD /api/keycloak-user-group-memberships/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'keycloak_user_group_memberships_head' to 'keycloak_user_group_memberships_count'

HEAD /api/keys/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'keys_head' to 'keys_count'

GET /api/lexis-links/

  • Modified query param: query
  • Description changed from '' to 'Filter by robot account username or type'

HEAD /api/lexis-links/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'lexis_links_head' to 'lexis_links_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by robot account username or type'

HEAD /api/marketplace-categories/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_categories_head' to 'marketplace_categories_count'

HEAD /api/marketplace-category-columns/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_category_columns_head' to 'marketplace_category_columns_count'

HEAD /api/marketplace-category-component-usages/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_category_component_usages_head' to 'marketplace_category_component_usages_count'

HEAD /api/marketplace-category-components/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_category_components_head' to 'marketplace_category_components_count'

HEAD /api/marketplace-category-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_category_groups_head' to 'marketplace_category_groups_count'

HEAD /api/marketplace-category-help-articles/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_category_help_articles_head' to 'marketplace_category_help_articles_count'

HEAD /api/marketplace-component-usages/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_component_usages_head' to 'marketplace_component_usages_count'

HEAD /api/marketplace-component-user-usages/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_component_user_usages_head' to 'marketplace_component_user_usages_count'

HEAD /api/marketplace-customer-estimated-cost-policies/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_customer_estimated_cost_policies_head' to 'marketplace_customer_estimated_cost_policies_count'

HEAD /api/marketplace-customer-estimated-cost-policies/actions/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_customer_estimated_cost_policies_actions_head' to 'marketplace_customer_estimated_cost_policies_actions_count'

HEAD /api/marketplace-customer-service-accounts/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_customer_service_accounts_head' to 'marketplace_customer_service_accounts_count'

HEAD /api/marketplace-integration-statuses/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_integration_statuses_head' to 'marketplace_integration_statuses_count'

HEAD /api/marketplace-offering-estimated-cost-policies/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_estimated_cost_policies_head' to 'marketplace_offering_estimated_cost_policies_count'

HEAD /api/marketplace-offering-estimated-cost-policies/actions/

  • Description changed from 'List available actions for OfferingEstimatedCostPolicy' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_estimated_cost_policies_actions_head' to 'marketplace_offering_estimated_cost_policies_actions_count'

HEAD /api/marketplace-offering-files/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_files_head' to 'marketplace_offering_files_count'

HEAD /api/marketplace-offering-permissions-log/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_permissions_log_head' to 'marketplace_offering_permissions_log_count'

HEAD /api/marketplace-offering-permissions/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_permissions_head' to 'marketplace_offering_permissions_count'

HEAD /api/marketplace-offering-referrals/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_referrals_head' to 'marketplace_offering_referrals_count'

HEAD /api/marketplace-offering-usage-policies/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_usage_policies_head' to 'marketplace_offering_usage_policies_count'

HEAD /api/marketplace-offering-usage-policies/actions/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_usage_policies_actions_head' to 'marketplace_offering_usage_policies_actions_count'

HEAD /api/marketplace-offering-user-roles/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_user_roles_head' to 'marketplace_offering_user_roles_count'

GET /api/marketplace-offering-users/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_provider_comment_url]
  • Modified query param: query
  • Description changed from '' to 'Search by offering name, username or user name'
  • Modified query param: state
  • Schema changed
    • Items changed
    • New enum values: [Error creating Error deleting]
    • Deleted enum values: [Error]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: service_provider_comment_url
        • Modified property: state
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OfferingUserStateEnum
            • New enum values: [Error creating Error deleting]
            • Deleted enum values: [Error]

HEAD /api/marketplace-offering-users/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_offering_users_head' to 'marketplace_offering_users_count'
  • Modified query param: query
  • Description changed from '' to 'Search by offering name, username or user name'
  • Modified query param: state
  • Schema changed
    • Items changed
    • New enum values: [Error creating Error deleting]
    • Deleted enum values: [Error]

POST /api/marketplace-offering-users/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment_url
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OfferingUserStateEnum
          • New enum values: [Error creating Error deleting]
          • Deleted enum values: [Error]

GET /api/marketplace-offering-users/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [service_provider_comment_url]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment_url
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OfferingUserStateEnum
          • New enum values: [Error creating Error deleting]
          • Deleted enum values: [Error]

PATCH /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment_url
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OfferingUserStateEnum
          • New enum values: [Error creating Error deleting]
          • Deleted enum values: [Error]

PUT /api/marketplace-offering-users/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: service_provider_comment_url
        • Modified property: state
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OfferingUserStateEnum
          • New enum values: [Error creating Error deleting]
          • Deleted enum values: [Error]

POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: comment_url

POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: comment_url

GET /api/marketplace-orders/

  • Modified query param: query
  • Description changed from '' to 'Search by order UUID, project name or resource name'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

HEAD /api/marketplace-orders/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_orders_head' to 'marketplace_orders_count'
  • Modified query param: query
  • Description changed from '' to 'Search by order UUID, project name or resource name'

POST /api/marketplace-orders/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-orders/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/marketplace-plan-components/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

HEAD /api/marketplace-plan-components/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_plan_components_head' to 'marketplace_plan_components_count'

GET /api/marketplace-plan-components/{id}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-plans/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: unit
          • New enum values: [quarter]

HEAD /api/marketplace-plans/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_plans_head' to 'marketplace_plans_count'

POST /api/marketplace-plans/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: unit
        • New enum values: [quarter]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

HEAD /api/marketplace-plans/usage_stats/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_plans_usage_stats_head' to 'marketplace_plans_usage_stats_count'

GET /api/marketplace-plans/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

PATCH /api/marketplace-plans/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: unit
        • New enum values: [quarter]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

PUT /api/marketplace-plans/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: unit
        • New enum values: [quarter]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

HEAD /api/marketplace-project-estimated-cost-policies/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_project_estimated_cost_policies_head' to 'marketplace_project_estimated_cost_policies_count'

HEAD /api/marketplace-project-estimated-cost-policies/actions/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_project_estimated_cost_policies_actions_head' to 'marketplace_project_estimated_cost_policies_actions_count'

HEAD /api/marketplace-project-service-accounts/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_project_service_accounts_head' to 'marketplace_project_service_accounts_count'

HEAD /api/marketplace-project-update-requests/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_project_update_requests_head' to 'marketplace_project_update_requests_count'

GET /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: limit_period
            • Property 'OneOf' changed
              • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

HEAD /api/marketplace-provider-offerings/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_provider_offerings_head' to 'marketplace_provider_offerings_count'

POST /api/marketplace-provider-offerings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: components
        • Items changed
        • Properties changed
          • Modified property: limit_period
          • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
            • New enum values: [quarterly]
      • Modified property: plans
        • Items changed
        • Properties changed
          • Modified property: unit
          • New enum values: [quarter]
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

HEAD /api/marketplace-provider-offerings/groups/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_provider_offerings_groups_head' to 'marketplace_provider_offerings_groups_count'

GET /api/marketplace-provider-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

POST /api/marketplace-provider-offerings/{uuid}/create_offering_component/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: limit_period
        • Property 'OneOf' changed
        • Modified schema: #/components/schemas/LimitPeriodEnum
          • New enum values: [quarterly]

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: additional_details
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: end_date_requested_by
          • ReadOnly changed from false to true

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: components
        • Items changed
        • Properties changed
          • Modified property: limit_period
          • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
            • New enum values: [quarterly]
      • Modified property: plans
        • Items changed
        • Properties changed
          • Modified property: unit
          • New enum values: [quarter]

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: limit_period
        • Property 'OneOf' changed
        • Modified schema: #/components/schemas/LimitPeriodEnum
          • New enum values: [quarterly]

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/marketplace-provider-resources/

  • Modified query param: query
  • Description changed from 'Query' to 'Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

HEAD /api/marketplace-provider-resources/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_provider_resources_head' to 'marketplace_provider_resources_count'
  • Modified query param: query
  • Description changed from 'Query' to 'Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor'

GET /api/marketplace-provider-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-provider-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-public-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: limit_period
            • Property 'OneOf' changed
              • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

HEAD /api/marketplace-public-offerings/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_public_offerings_head' to 'marketplace_public_offerings_count'

GET /api/marketplace-public-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

GET /api/marketplace-public-offerings/{uuid}/plans/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: unit
          • New enum values: [quarter]

GET /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

HEAD /api/marketplace-remote-synchronisations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_remote_synchronisations_head' to 'marketplace_remote_synchronisations_count'

HEAD /api/marketplace-resource-users/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_resource_users_head' to 'marketplace_resource_users_count'

GET /api/marketplace-resources/

  • Modified query param: query
  • Description changed from 'Query' to 'Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

HEAD /api/marketplace-resources/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_resources_head' to 'marketplace_resources_count'
  • Modified query param: query
  • Description changed from 'Query' to 'Search by resource UUID, name, backend ID, effective ID, IPs or hypervisor'

GET /api/marketplace-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-resources/{uuid}/details/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Modified property: plan_unit
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
              • New enum values: [quarter]
        • Modified property: plan_unit
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
          • New enum values: [quarter]

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

HEAD /api/marketplace-robot-accounts/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_robot_accounts_head' to 'marketplace_robot_accounts_count'

HEAD /api/marketplace-screenshots/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_screenshots_head' to 'marketplace_screenshots_count'

HEAD /api/marketplace-script-async-dry-run/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_script_async_dry_run_head' to 'marketplace_script_async_dry_run_count'

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
        • Items changed
          • Properties changed
          • Modified property: unit
            • New enum values: [quarter]

HEAD /api/marketplace-sections/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_sections_head' to 'marketplace_sections_count'

HEAD /api/marketplace-service-providers/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_service_providers_head' to 'marketplace_service_providers_count'

GET /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, UUID, backend ID or resource effective ID'

GET /api/marketplace-service-providers/{service_provider_uuid}/customers/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: limit_period
            • Property 'OneOf' changed
              • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plans
          • Items changed
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

GET /api/marketplace-service-providers/{service_provider_uuid}/projects/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, UUID, backend ID or resource effective ID'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: end_date_requested_by
          • ReadOnly changed from false to true

GET /api/marketplace-service-providers/{service_provider_uuid}/user_customers/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number'

GET /api/marketplace-service-providers/{service_provider_uuid}/users/

  • Modified query param: query
  • Description changed from '' to 'Filter by first name, last name, civil number, username or email'

HEAD /api/marketplace-stats/component_usages/

  • Description changed from 'Return component usages for current month.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_component_usages_head' to 'marketplace_stats_component_usages_count'

HEAD /api/marketplace-stats/component_usages_per_month/

  • Description changed from 'Return component usages per month.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_component_usages_per_month_head' to 'marketplace_stats_component_usages_per_month_count'

HEAD /api/marketplace-stats/component_usages_per_project/

  • Description changed from 'Return component usages per project.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_component_usages_per_project_head' to 'marketplace_stats_component_usages_per_project_count'

HEAD /api/marketplace-stats/count_active_resources_grouped_by_offering/

  • Description changed from 'Count active resources grouped by offering.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_active_resources_grouped_by_offering_head' to 'marketplace_stats_count_active_resources_grouped_by_offering_count'

HEAD /api/marketplace-stats/count_active_resources_grouped_by_offering_country/

  • Description changed from 'Count active resources grouped by offering country.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_active_resources_grouped_by_offering_country_head' to 'marketplace_stats_count_active_resources_grouped_by_offering_country_count'

HEAD /api/marketplace-stats/count_active_resources_grouped_by_organization_group/

  • Description changed from 'Count active resources grouped by organization group.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_active_resources_grouped_by_organization_group_head' to 'marketplace_stats_count_active_resources_grouped_by_organization_group_count'

HEAD /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/

  • Description changed from 'Count projects grouped by provider and industry flag' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_head' to 'marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_count'

HEAD /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/

  • Description changed from 'Count projects grouped by provider and OECD code' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_projects_grouped_by_provider_and_oecd_head' to 'marketplace_stats_count_projects_grouped_by_provider_and_oecd_count'

HEAD /api/marketplace-stats/count_projects_of_service_providers/

  • Description changed from 'Count projects of service providers.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_projects_of_service_providers_head' to 'marketplace_stats_count_projects_of_service_providers_count'

HEAD /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/

  • Description changed from 'Count projects of service providers grouped by OECD.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_head' to 'marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_count'

HEAD /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/

  • Description changed from 'Count unique users connected with active resources of service provider.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_head' to 'marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_count'

HEAD /api/marketplace-stats/count_users_of_service_providers/

  • Description changed from 'Count users of service providers.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_count_users_of_service_providers_head' to 'marketplace_stats_count_users_of_service_providers_count'

HEAD /api/marketplace-stats/customer_member_count/

  • Description changed from 'Return count of customer members.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_customer_member_count_head' to 'marketplace_stats_customer_member_count_count'

HEAD /api/marketplace-stats/offerings_counter_stats/

  • Description changed from 'Retrieve statistics about the number of offerings, grouped by category and service provider.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_offerings_counter_stats_head' to 'marketplace_stats_offerings_counter_stats_count'

HEAD /api/marketplace-stats/organization_project_count/

  • Description changed from 'Return project count per organization.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_organization_project_count_head' to 'marketplace_stats_organization_project_count_count'

HEAD /api/marketplace-stats/organization_resource_count/

  • Description changed from 'Return resource count per organization.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_organization_resource_count_head' to 'marketplace_stats_organization_resource_count_count'

HEAD /api/marketplace-stats/projects_limits_grouped_by_industry_flag/

  • Description changed from 'Group project limits by industry flag.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_projects_limits_grouped_by_industry_flag_head' to 'marketplace_stats_projects_limits_grouped_by_industry_flag_count'

HEAD /api/marketplace-stats/projects_limits_grouped_by_oecd/

  • Description changed from 'Group project limits by OECD code.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_projects_limits_grouped_by_oecd_head' to 'marketplace_stats_projects_limits_grouped_by_oecd_count'

HEAD /api/marketplace-stats/projects_usages_grouped_by_industry_flag/

  • Description changed from 'Group project usages by industry flag.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_projects_usages_grouped_by_industry_flag_head' to 'marketplace_stats_projects_usages_grouped_by_industry_flag_count'

HEAD /api/marketplace-stats/projects_usages_grouped_by_oecd/

  • Description changed from 'Group project usages by OECD code.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_projects_usages_grouped_by_oecd_head' to 'marketplace_stats_projects_usages_grouped_by_oecd_count'

HEAD /api/marketplace-stats/resources_limits/

  • Description changed from 'Return resources limits per offering.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_resources_limits_head' to 'marketplace_stats_resources_limits_count'

HEAD /api/marketplace-stats/total_cost_of_active_resources_per_offering/

  • Description changed from 'Total cost of active resources per offering.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'marketplace_stats_total_cost_of_active_resources_per_offering_head' to 'marketplace_stats_total_cost_of_active_resources_per_offering_count'

HEAD /api/notification-messages-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'notification_messages_templates_head' to 'notification_messages_templates_count'

GET /api/notification-messages/

  • Modified query param: query
  • Description changed from '' to 'Filter by key or description'

HEAD /api/notification-messages/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'notification_messages_head' to 'notification_messages_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by key or description'

HEAD /api/openstack-backups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_backups_head' to 'openstack_backups_count'

HEAD /api/openstack-flavors/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_flavors_head' to 'openstack_flavors_count'

HEAD /api/openstack-flavors/usage_stats/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_flavors_usage_stats_head' to 'openstack_flavors_usage_stats_count'

HEAD /api/openstack-floating-ips/

  • Description changed from 'Status DOWN means that floating IP is not linked to a VM, status ACTIVE means that it is in use.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_floating_ips_head' to 'openstack_floating_ips_count'

HEAD /api/openstack-images/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_images_head' to 'openstack_images_count'

HEAD /api/openstack-images/usage_stats/

  • Description changed from '' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_images_usage_stats_head' to 'openstack_images_usage_stats_count'

HEAD /api/openstack-instance-availability-zones/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_instance_availability_zones_head' to 'openstack_instance_availability_zones_count'

GET /api/openstack-instances/

  • Modified query param: query
  • Description changed from '' to 'Search by name, internal IP, or external IP'

HEAD /api/openstack-instances/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_instances_head' to 'openstack_instances_count'
  • Modified query param: query
  • Description changed from '' to 'Search by name, internal IP, or external IP'

HEAD /api/openstack-marketplace-tenants/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_marketplace_tenants_head' to 'openstack_marketplace_tenants_count'

HEAD /api/openstack-migrations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_migrations_head' to 'openstack_migrations_count'

HEAD /api/openstack-network-rbac-policies/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_network_rbac_policies_head' to 'openstack_network_rbac_policies_count'

HEAD /api/openstack-networks/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_networks_head' to 'openstack_networks_count'

GET /api/openstack-ports/

  • Modified query param: query
  • Description changed from 'Query' to 'Search by name, MAC address or backend ID'

HEAD /api/openstack-ports/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_ports_head' to 'openstack_ports_count'
  • Modified query param: query
  • Description changed from 'Query' to 'Search by name, MAC address or backend ID'

HEAD /api/openstack-routers/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_routers_head' to 'openstack_routers_count'

GET /api/openstack-security-groups/

  • Modified query param: query
  • Description changed from '' to 'Search by name or description'

HEAD /api/openstack-security-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_security_groups_head' to 'openstack_security_groups_count'
  • Modified query param: query
  • Description changed from '' to 'Search by name or description'

HEAD /api/openstack-server-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_server_groups_head' to 'openstack_server_groups_count'

HEAD /api/openstack-snapshots/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_snapshots_head' to 'openstack_snapshots_count'

HEAD /api/openstack-subnets/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_subnets_head' to 'openstack_subnets_count'

HEAD /api/openstack-tenants/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_tenants_head' to 'openstack_tenants_count'

HEAD /api/openstack-volume-availability-zones/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_volume_availability_zones_head' to 'openstack_volume_availability_zones_count'

HEAD /api/openstack-volume-types/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_volume_types_head' to 'openstack_volume_types_count'

HEAD /api/openstack-volume-types/names/

  • Description changed from 'Return a list of unique volume type names.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_volume_types_names_head' to 'openstack_volume_types_names_count'

HEAD /api/openstack-volumes/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'openstack_volumes_head' to 'openstack_volumes_count'

HEAD /api/organization-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'organization_groups_head' to 'organization_groups_count'

HEAD /api/payment-profiles/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'payment_profiles_head' to 'payment_profiles_count'

HEAD /api/payments/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'payments_head' to 'payments_count'

HEAD /api/project-credits/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'project_credits_head' to 'project_credits_count'

HEAD /api/project-quotas/

  • Description changed from 'List project quotas.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'project_quotas_head' to 'project_quotas_count'

HEAD /api/project-types/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'project_types_head' to 'project_types_count'

GET /api/projects/

  • Modified query param: query
  • Description changed from '' to 'Filter by name, UUID, backend ID or resource effective ID'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: end_date_requested_by
          • ReadOnly changed from false to true

HEAD /api/projects/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'projects_head' to 'projects_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by name, UUID, backend ID or resource effective ID'

POST /api/projects/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: end_date_requested_by
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: end_date_requested_by
        • ReadOnly changed from false to true

GET /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: end_date_requested_by
        • ReadOnly changed from false to true

PATCH /api/projects/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: end_date_requested_by
        • ReadOnly changed from false to true

PUT /api/projects/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: end_date_requested_by
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: end_date_requested_by
        • ReadOnly changed from false to true

POST /api/projects/{uuid}/move_project/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: end_date_requested_by
        • ReadOnly changed from false to true

GET /api/promotions-campaigns/

  • Modified query param: query
  • Description changed from '' to 'Search by name or coupon code'

HEAD /api/promotions-campaigns/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'promotions_campaigns_head' to 'promotions_campaigns_count'
  • Modified query param: query
  • Description changed from '' to 'Search by name or coupon code'

GET /api/promotions-campaigns/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Modified property: plan_unit
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BillingUnit
                • New enum values: [quarter]
        • Modified property: plan_unit
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BillingUnit
            • New enum values: [quarter]

GET /api/proposal-proposals/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: can_submit
        • New required property: compliance_status
        • Properties changed
        • New property: can_submit
        • New property: compliance_status

HEAD /api/proposal-proposals/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'proposal_proposals_head' to 'proposal_proposals_count'

POST /api/proposal-proposals/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: can_submit
        • New required property: compliance_status
      • Properties changed
        • New property: can_submit
        • New property: compliance_status

GET /api/proposal-proposals/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: can_submit
        • New required property: compliance_status
      • Properties changed
        • New property: can_submit
        • New property: compliance_status

GET /api/proposal-proposals/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: requested_offering
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
            • Properties changed
            • Modified property: components
              • Items changed
              • Properties changed
                • Modified property: limit_period
                • Property 'OneOf' changed
                  • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
                • Properties changed
                • Modified property: unit
                  • New enum values: [quarter]

POST /api/proposal-proposals/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

GET /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

GET /api/proposal-protected-calls/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [compliance_checklist compliance_checklist_name]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: compliance_checklist
        • New property: compliance_checklist_name
        • Modified property: offerings
          • Items changed
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
          • Items changed
          • Properties changed
            • Modified property: requested_offering_plan
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

HEAD /api/proposal-protected-calls/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'proposal_protected_calls_head' to 'proposal_protected_calls_count'

POST /api/proposal-protected-calls/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: compliance_checklist
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compliance_checklist
        • New property: compliance_checklist_name
        • Modified property: offerings
        • Items changed
          • Properties changed
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: limit_period
              • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                • New enum values: [quarterly]
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • Modified property: requested_offering_plan
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]

GET /api/proposal-protected-calls/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [compliance_checklist compliance_checklist_name]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compliance_checklist
        • New property: compliance_checklist_name
        • Modified property: offerings
        • Items changed
          • Properties changed
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: limit_period
              • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                • New enum values: [quarterly]
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • Modified property: requested_offering_plan
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]

PATCH /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: compliance_checklist
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compliance_checklist
        • New property: compliance_checklist_name
        • Modified property: offerings
        • Items changed
          • Properties changed
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: limit_period
              • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                • New enum values: [quarterly]
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • Modified property: requested_offering_plan
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]

PUT /api/proposal-protected-calls/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: compliance_checklist
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compliance_checklist
        • New property: compliance_checklist_name
        • Modified property: offerings
        • Items changed
          • Properties changed
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: limit_period
              • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                • New enum values: [quarterly]
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • Modified property: requested_offering_plan
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]

POST /api/proposal-protected-calls/{uuid}/activate/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

POST /api/proposal-protected-calls/{uuid}/archive/

  • Responses changed
  • Modified response: 200
    • Description changed from 'No response body' to ''
    • Content changed
    • New media type: application/json

GET /api/proposal-protected-calls/{uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: limit_period
            • Property 'OneOf' changed
              • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
            • Properties changed
            • Modified property: unit
              • New enum values: [quarter]

POST /api/proposal-protected-calls/{uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

GET /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

GET /api/proposal-protected-calls/{uuid}/resource_templates/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: requested_offering_plan
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
            • Properties changed
            • Modified property: unit
              • New enum values: [quarter]

POST /api/proposal-protected-calls/{uuid}/resource_templates/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering_plan
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering_plan
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering_plan
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering_plan
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: compliance_checklist
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: compliance_checklist
        • New property: compliance_checklist_name
        • Modified property: offerings
        • Items changed
          • Properties changed
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: limit_period
              • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                • New enum values: [quarterly]
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • Modified property: requested_offering_plan
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]

GET /api/proposal-public-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: offerings
          • Items changed
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
          • Items changed
          • Properties changed
            • Modified property: requested_offering_plan
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

HEAD /api/proposal-public-calls/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'proposal_public_calls_head' to 'proposal_public_calls_count'

GET /api/proposal-public-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: offerings
        • Items changed
          • Properties changed
          • Modified property: components
            • Items changed
            • Properties changed
              • Modified property: limit_period
              • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                • New enum values: [quarterly]
          • Modified property: plan_details
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]
        • Modified property: resource_templates
        • Items changed
          • Properties changed
          • Modified property: requested_offering_plan
            • Property 'AllOf' changed
            • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
              • Modified property: unit
                • New enum values: [quarter]

GET /api/proposal-requested-offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: components
          • Items changed
          • Properties changed
            • Modified property: limit_period
            • Property 'OneOf' changed
              • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
            • Properties changed
            • Modified property: unit
              • New enum values: [quarter]

HEAD /api/proposal-requested-offerings/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'proposal_requested_offerings_head' to 'proposal_requested_offerings_count'

GET /api/proposal-requested-offerings/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: components
        • Items changed
          • Properties changed
          • Modified property: limit_period
            • Property 'OneOf' changed
            • Modified schema: #/components/schemas/LimitPeriodEnum
              • New enum values: [quarterly]
        • Modified property: plan_details
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasePublicPlan
          • Properties changed
            • Modified property: unit
            • New enum values: [quarter]

GET /api/proposal-requested-resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: requested_offering
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
            • Properties changed
            • Modified property: components
              • Items changed
              • Properties changed
                • Modified property: limit_period
                • Property 'OneOf' changed
                  • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
              • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
                • Properties changed
                • Modified property: unit
                  • New enum values: [quarter]

HEAD /api/proposal-requested-resources/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'proposal_requested_resources_head' to 'proposal_requested_resources_count'

GET /api/proposal-requested-resources/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: requested_offering
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/NestedRequestedOffering
          • Properties changed
            • Modified property: components
            • Items changed
              • Properties changed
              • Modified property: limit_period
                • Property 'OneOf' changed
                • Modified schema: #/components/schemas/LimitPeriodEnum
                  • New enum values: [quarterly]
            • Modified property: plan_details
            • Property 'AllOf' changed
              • Modified schema: #/components/schemas/BasePublicPlan
              • Properties changed
                • Modified property: unit
                • New enum values: [quarter]

HEAD /api/proposal-reviews/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'proposal_reviews_head' to 'proposal_reviews_count'

GET /api/provider-invoice-items/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: unit
          • New enum values: [quarter]

HEAD /api/provider-invoice-items/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'provider_invoice_items_head' to 'provider_invoice_items_count'

GET /api/provider-invoice-items/{id}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: unit
        • New enum values: [quarter]

HEAD /api/rancher-apps/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_apps_head' to 'rancher_apps_count'

HEAD /api/rancher-catalogs/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_catalogs_head' to 'rancher_catalogs_count'

HEAD /api/rancher-cluster-security-groups/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_cluster_security_groups_head' to 'rancher_cluster_security_groups_count'

HEAD /api/rancher-cluster-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_cluster_templates_head' to 'rancher_cluster_templates_count'

HEAD /api/rancher-clusters/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_clusters_head' to 'rancher_clusters_count'

HEAD /api/rancher-hpas/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_hpas_head' to 'rancher_hpas_count'

HEAD /api/rancher-ingresses/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_ingresses_head' to 'rancher_ingresses_count'

HEAD /api/rancher-namespaces/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_namespaces_head' to 'rancher_namespaces_count'

HEAD /api/rancher-nodes/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_nodes_head' to 'rancher_nodes_count'

HEAD /api/rancher-projects/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_projects_head' to 'rancher_projects_count'

HEAD /api/rancher-role-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_role_templates_head' to 'rancher_role_templates_count'

HEAD /api/rancher-services/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_services_head' to 'rancher_services_count'

HEAD /api/rancher-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_templates_head' to 'rancher_templates_count'

HEAD /api/rancher-users/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_users_head' to 'rancher_users_count'

HEAD /api/rancher-workloads/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'rancher_workloads_head' to 'rancher_workloads_count'

HEAD /api/roles/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'roles_head' to 'roles_count'

HEAD /api/service-settings/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'service_settings_head' to 'service_settings_count'

HEAD /api/slurm-allocation-user-usage/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'slurm_allocation_user_usage_head' to 'slurm_allocation_user_usage_count'

HEAD /api/slurm-allocations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'slurm_allocations_head' to 'slurm_allocations_count'

HEAD /api/slurm-associations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'slurm_associations_head' to 'slurm_associations_count'

HEAD /api/slurm-jobs/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'slurm_jobs_head' to 'slurm_jobs_count'

HEAD /api/support-attachments/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_attachments_head' to 'support_attachments_count'

HEAD /api/support-comments/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_comments_head' to 'support_comments_count'

HEAD /api/support-feedbacks/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_feedbacks_head' to 'support_feedbacks_count'

HEAD /api/support-issues/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_issues_head' to 'support_issues_count'

HEAD /api/support-priorities/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_priorities_head' to 'support_priorities_count'

HEAD /api/support-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_templates_head' to 'support_templates_count'

HEAD /api/support-users/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'support_users_head' to 'support_users_count'

HEAD /api/user-agreements/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'user_agreements_head' to 'user_agreements_count'

HEAD /api/user-group-invitations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'user_group_invitations_head' to 'user_group_invitations_count'

HEAD /api/user-invitations/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'user_invitations_head' to 'user_invitations_count'

HEAD /api/user-permission-requests/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'user_permission_requests_head' to 'user_permission_requests_count'

HEAD /api/user-permissions/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'user_permissions_head' to 'user_permissions_count'

GET /api/users/

  • Modified query param: query
  • Description changed from '' to 'Filter by first name, last name, civil number, username or email'

HEAD /api/users/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'users_head' to 'users_count'
  • Modified query param: query
  • Description changed from '' to 'Filter by first name, last name, civil number, username or email'

HEAD /api/users/me/

  • Description changed from 'Get current user details, including authentication token.' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'users_me_head' to 'users_me_count'

HEAD /api/vmware-clusters/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_clusters_head' to 'vmware_clusters_count'

HEAD /api/vmware-datastores/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_datastores_head' to 'vmware_datastores_count'

HEAD /api/vmware-disks/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_disks_head' to 'vmware_disks_count'

HEAD /api/vmware-folders/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_folders_head' to 'vmware_folders_count'

HEAD /api/vmware-networks/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_networks_head' to 'vmware_networks_count'

HEAD /api/vmware-ports/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_ports_head' to 'vmware_ports_count'

HEAD /api/vmware-templates/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_templates_head' to 'vmware_templates_count'

HEAD /api/vmware-virtual-machine/

  • Description changed from 'Mixin to optimize HEAD requests for DRF views bypassing serializer processing' to 'Get number of items in the collection matching the request parameters.'
  • OperationID changed from 'vmware_virtual_machine_head' to 'vmware_virtual_machine_count'

OpenAPI schema diff - 7.7.6

For version 7.7.6

New Endpoints: 11

GET /api/marketplace-offering-users/{uuid}/checklist/
GET /api/marketplace-offering-users/{uuid}/checklist_review/
GET /api/marketplace-offering-users/{uuid}/completion_review_status/
GET /api/marketplace-offering-users/{uuid}/completion_status/
POST /api/marketplace-offering-users/{uuid}/submit_answers/
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/compliance_overview/
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/offering_users/
GET /api/marketplace-service-providers/{service_provider_uuid}/project_service_accounts/
GET /api/public-maintenance-announcements/
HEAD /api/public-maintenance-announcements/
GET /api/public-maintenance-announcements/{uuid}/

Deleted Endpoints: None

Modified Endpoints: 130

GET /api/admin-announcements/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [maintenance_affected_offerings maintenance_name maintenance_scheduled_end maintenance_scheduled_start maintenance_service_provider maintenance_state maintenance_type maintenance_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: maintenance_affected_offerings
        • New property: maintenance_name
        • New property: maintenance_scheduled_end
        • New property: maintenance_scheduled_start
        • New property: maintenance_service_provider
        • New property: maintenance_state
        • New property: maintenance_type
        • New property: maintenance_uuid

POST /api/admin-announcements/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: maintenance_affected_offerings
        • New property: maintenance_name
        • New property: maintenance_scheduled_end
        • New property: maintenance_scheduled_start
        • New property: maintenance_service_provider
        • New property: maintenance_state
        • New property: maintenance_type
        • New property: maintenance_uuid

GET /api/admin-announcements/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [maintenance_affected_offerings maintenance_name maintenance_scheduled_end maintenance_scheduled_start maintenance_service_provider maintenance_state maintenance_type maintenance_uuid]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: maintenance_affected_offerings
        • New property: maintenance_name
        • New property: maintenance_scheduled_end
        • New property: maintenance_scheduled_start
        • New property: maintenance_service_provider
        • New property: maintenance_state
        • New property: maintenance_type
        • New property: maintenance_uuid

PATCH /api/admin-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: maintenance_affected_offerings
        • New property: maintenance_name
        • New property: maintenance_scheduled_end
        • New property: maintenance_scheduled_start
        • New property: maintenance_service_provider
        • New property: maintenance_state
        • New property: maintenance_type
        • New property: maintenance_uuid

PUT /api/admin-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: maintenance_affected_offerings
        • New property: maintenance_name
        • New property: maintenance_scheduled_end
        • New property: maintenance_scheduled_start
        • New property: maintenance_service_provider
        • New property: maintenance_state
        • New property: maintenance_type
        • New property: maintenance_uuid

GET /api/booking-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: has_compliance_requirements

GET /api/booking-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/customers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [organization_groups users_count]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: organization_groups
        • Deleted property: users_count

POST /api/customers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: organization_groups
        • Deleted property: users_count

GET /api/customers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [organization_groups users_count]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: organization_groups
        • Deleted property: users_count

PATCH /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: organization_groups
        • Deleted property: users_count

PUT /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: organization_groups
        • Deleted property: users_count

POST /api/marketplace-orders/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: attributes
        • Property 'OneOf' changed
        • Schemas added: #/components/schemas/AzureVirtualMachineCreateOrderAttributes, #/components/schemas/AzureSQLServerCreateOrderAttributes, #/components/schemas/OpenStackTenantCreateOrderAttributes, #/components/schemas/OpenStackInstanceCreateOrderAttributes, #/components/schemas/OpenStackVolumeCreateOrderAttributes, #/components/schemas/MarketplaceRancherCreateOrderAttributes, #/components/schemas/MarketplaceManagedRancherCreateOrderAttributes, #/components/schemas/SlurmInvoicesSlurmPackageCreateOrderAttributes, #/components/schemas/VMwareVirtualMachineCreateOrderAttributes
        • Description changed from '' to 'Attributes structure depends on the offering type specified in the parent object'

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-project-update-requests/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: review_comment
          • Description changed from '' to 'Optional comment provided during review'
        • Modified property: reviewed_at
          • Description changed from '' to 'Timestamp when the review was completed'

GET /api/marketplace-project-update-requests/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: review_comment
        • Description changed from '' to 'Optional comment provided during review'
        • Modified property: reviewed_at
        • Description changed from '' to 'Timestamp when the review was completed'

GET /api/marketplace-provider-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: has_compliance_requirements

POST /api/marketplace-provider-offerings/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: has_compliance_requirements
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-provider-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-public-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-public-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [has_compliance_requirements]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/marketplace-robot-accounts/

  • New query param: field
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
        • Properties changed
        • Modified property: fingerprints
          • Items changed
          • Required changed
            • Deleted required property: md5
            • Deleted required property: sha256
            • Deleted required property: sha512
        • Modified property: responsible_user
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
            • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
          • Items changed
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid

POST /api/marketplace-robot-accounts/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512

GET /api/marketplace-robot-accounts/{uuid}/

  • New query param: field
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512
        • Modified property: responsible_user
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
        • Items changed
          • Required changed
          • Deleted required property: full_name
          • Deleted required property: url
          • Deleted required property: username
          • Deleted required property: uuid

PATCH /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512

PUT /api/marketplace-robot-accounts/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512

POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512
        • Modified property: responsible_user
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
        • Items changed
          • Required changed
          • Deleted required property: full_name
          • Deleted required property: url
          • Deleted required property: username
          • Deleted required property: uuid

POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512
        • Modified property: responsible_user
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
        • Items changed
          • Required changed
          • Deleted required property: full_name
          • Deleted required property: url
          • Deleted required property: username
          • Deleted required property: uuid

POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512
        • Modified property: responsible_user
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
        • Items changed
          • Required changed
          • Deleted required property: full_name
          • Deleted required property: url
          • Deleted required property: username
          • Deleted required property: uuid

POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512
        • Modified property: responsible_user
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
        • Items changed
          • Required changed
          • Deleted required property: full_name
          • Deleted required property: url
          • Deleted required property: username
          • Deleted required property: uuid

POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: backend_id
        • Deleted required property: created
        • Deleted required property: customer_name
        • Deleted required property: customer_uuid
        • Deleted required property: fingerprints
        • Deleted required property: modified
        • Deleted required property: offering_customer_uuid
        • Deleted required property: offering_plugin_options
        • Deleted required property: project_name
        • Deleted required property: project_uuid
        • Deleted required property: resource
        • Deleted required property: resource_name
        • Deleted required property: resource_uuid
        • Deleted required property: responsible_user
        • Deleted required property: type
        • Deleted required property: url
        • Deleted required property: user_keys
        • Deleted required property: users
        • Deleted required property: uuid
      • Properties changed
        • Modified property: fingerprints
        • Items changed
          • Required changed
          • Deleted required property: md5
          • Deleted required property: sha256
          • Deleted required property: sha512
        • Modified property: responsible_user
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/BasicUser
          • Required changed
            • Deleted required property: full_name
            • Deleted required property: url
            • Deleted required property: username
            • Deleted required property: uuid
        • Modified property: users
        • Items changed
          • Required changed
          • Deleted required property: full_name
          • Deleted required property: url
          • Deleted required property: username
          • Deleted required property: uuid

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: has_compliance_requirements

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance
          • Description changed from '' to 'Instance that this backup is created from'
        • Modified property: instance_floating_ips
          • Items changed
          • Properties changed
            • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
            • Modified property: port_fixed_ips
            • Items changed
              • Properties changed
              • Modified property: ip_address
                • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
                • Description changed from '' to 'ID of the subnet in which to assign the IP address'
            • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
            • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_ports
          • Items changed
          • Properties changed
            • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
            • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
            • Modified property: fixed_ips
            • Items changed
              • Properties changed
              • Modified property: ip_address
                • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
                • Description changed from '' to 'ID of the subnet in which to assign the IP address'
            • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
            • Modified property: security_groups
            • Items changed
              • Properties changed
              • Modified property: rules
                • Items changed
                • Properties changed
                  • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                  • Modified property: direction
                  • Property 'AllOf' changed
                    • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                  • Modified property: ethertype
                  • Property 'AllOf' changed
                    • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                  • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                  • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                  • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                  • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
            • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
            • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_security_groups
          • Items changed
          • Properties changed
            • Deleted property: description
            • Deleted property: name
            • Deleted property: rules
            • Deleted property: state
            • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: flavor
            • Description changed from '' to 'Flavor to be used for the restored instance. If not specified, original instance flavor will be used'
            • Modified property: floating_ips
            • Description changed from '' to 'Floating IPs that will be assigned to the restored instance'
            • Items changed
              • Properties changed
              • Modified property: address
                • Description changed from '' to 'The public IPv4 address of the floating IP'
              • Modified property: port_fixed_ips
                • Items changed
                • Properties changed
                  • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                  • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: port_mac_address
                • Description changed from '' to 'MAC address of the port'
              • Modified property: subnet_cidr
                • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
            • Modified property: instance
            • Description changed from '' to 'Instance that is being restored from the backup'
            • Modified property: ports
            • Description changed from '' to 'Network ports that will be attached to the restored instance'
            • Items changed
              • Properties changed
              • Modified property: device_id
                • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
              • Modified property: device_owner
                • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
              • Modified property: fixed_ips
                • Items changed
                • Properties changed
                  • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                  • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: mac_address
                • Description changed from '' to 'MAC address of the port'
              • Modified property: security_groups
                • Items changed
                • Properties changed
                  • Modified property: rules
                  • Items changed
                    • Properties changed
                    • Modified property: cidr
                      • Description changed from '' to 'CIDR notation for the source/destination network address range'
                    • Modified property: direction
                      • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/DirectionEnum
                      • Type changed from 'string' to ''
                      • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                      • Deleted enum values: [ingress egress]
                    • Modified property: ethertype
                      • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/EthertypeEnum
                      • Type changed from 'string' to ''
                      • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                      • Deleted enum values: [IPv4 IPv6]
                    • Modified property: from_port
                      • Description changed from '' to 'Starting port number in the range (1-65535)'
                    • Modified property: protocol
                      • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                    • Modified property: remote_group
                      • Description changed from '' to 'Remote security group that this rule references, if any'
                    • Modified property: to_port
                      • Description changed from '' to 'Ending port number in the range (1-65535)'
              • Modified property: subnet
                • Description changed from '' to 'Subnet to which this port belongs'
              • Modified property: subnet_cidr
                • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
            • Modified property: security_groups
            • Description changed from '' to 'Security groups that will be assigned to the restored instance'
            • Items changed
              • Properties changed
              • Deleted property: description
              • Deleted property: name
              • Deleted property: rules
              • Deleted property: state
              • Modified property: url
                • Format changed from 'uri' to ''
                • ReadOnly changed from true to false

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance
        • Description changed from '' to 'Instance that this backup is created from'
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: flavor
            • Description changed from '' to 'Flavor to be used for the restored instance. If not specified, original instance flavor will be used'
          • Modified property: floating_ips
            • Description changed from '' to 'Floating IPs that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: address
              • Description changed from '' to 'The public IPv4 address of the floating IP'
              • Modified property: port_fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: port_mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: instance
            • Description changed from '' to 'Instance that is being restored from the backup'
          • Modified property: ports
            • Description changed from '' to 'Network ports that will be attached to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: device_id
              • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
              • Modified property: device_owner
              • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
              • Modified property: fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: security_groups
              • Items changed
                • Properties changed
                • Modified property: rules
                  • Items changed
                  • Properties changed
                    • Modified property: cidr
                    • Description changed from '' to 'CIDR notation for the source/destination network address range'
                    • Modified property: direction
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/DirectionEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                    • Deleted enum values: [ingress egress]
                    • Modified property: ethertype
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/EthertypeEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                    • Deleted enum values: [IPv4 IPv6]
                    • Modified property: from_port
                    • Description changed from '' to 'Starting port number in the range (1-65535)'
                    • Modified property: protocol
                    • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                    • Modified property: remote_group
                    • Description changed from '' to 'Remote security group that this rule references, if any'
                    • Modified property: to_port
                    • Description changed from '' to 'Ending port number in the range (1-65535)'
              • Modified property: subnet
              • Description changed from '' to 'Subnet to which this port belongs'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: security_groups
            • Description changed from '' to 'Security groups that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Deleted property: description
              • Deleted property: name
              • Deleted property: rules
              • Deleted property: state
              • Modified property: url
              • Format changed from 'uri' to ''
              • ReadOnly changed from true to false

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance
        • Description changed from '' to 'Instance that this backup is created from'
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: flavor
            • Description changed from '' to 'Flavor to be used for the restored instance. If not specified, original instance flavor will be used'
          • Modified property: floating_ips
            • Description changed from '' to 'Floating IPs that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: address
              • Description changed from '' to 'The public IPv4 address of the floating IP'
              • Modified property: port_fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: port_mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: instance
            • Description changed from '' to 'Instance that is being restored from the backup'
          • Modified property: ports
            • Description changed from '' to 'Network ports that will be attached to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: device_id
              • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
              • Modified property: device_owner
              • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
              • Modified property: fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: security_groups
              • Items changed
                • Properties changed
                • Modified property: rules
                  • Items changed
                  • Properties changed
                    • Modified property: cidr
                    • Description changed from '' to 'CIDR notation for the source/destination network address range'
                    • Modified property: direction
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/DirectionEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                    • Deleted enum values: [ingress egress]
                    • Modified property: ethertype
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/EthertypeEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                    • Deleted enum values: [IPv4 IPv6]
                    • Modified property: from_port
                    • Description changed from '' to 'Starting port number in the range (1-65535)'
                    • Modified property: protocol
                    • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                    • Modified property: remote_group
                    • Description changed from '' to 'Remote security group that this rule references, if any'
                    • Modified property: to_port
                    • Description changed from '' to 'Ending port number in the range (1-65535)'
              • Modified property: subnet
              • Description changed from '' to 'Subnet to which this port belongs'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: security_groups
            • Description changed from '' to 'Security groups that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Deleted property: description
              • Deleted property: name
              • Deleted property: rules
              • Deleted property: state
              • Modified property: url
              • Format changed from 'uri' to ''
              • ReadOnly changed from true to false

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance
        • Description changed from '' to 'Instance that this backup is created from'
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: flavor
            • Description changed from '' to 'Flavor to be used for the restored instance. If not specified, original instance flavor will be used'
          • Modified property: floating_ips
            • Description changed from '' to 'Floating IPs that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: address
              • Description changed from '' to 'The public IPv4 address of the floating IP'
              • Modified property: port_fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: port_mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: instance
            • Description changed from '' to 'Instance that is being restored from the backup'
          • Modified property: ports
            • Description changed from '' to 'Network ports that will be attached to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: device_id
              • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
              • Modified property: device_owner
              • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
              • Modified property: fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: security_groups
              • Items changed
                • Properties changed
                • Modified property: rules
                  • Items changed
                  • Properties changed
                    • Modified property: cidr
                    • Description changed from '' to 'CIDR notation for the source/destination network address range'
                    • Modified property: direction
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/DirectionEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                    • Deleted enum values: [ingress egress]
                    • Modified property: ethertype
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/EthertypeEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                    • Deleted enum values: [IPv4 IPv6]
                    • Modified property: from_port
                    • Description changed from '' to 'Starting port number in the range (1-65535)'
                    • Modified property: protocol
                    • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                    • Modified property: remote_group
                    • Description changed from '' to 'Remote security group that this rule references, if any'
                    • Modified property: to_port
                    • Description changed from '' to 'Ending port number in the range (1-65535)'
              • Modified property: subnet
              • Description changed from '' to 'Subnet to which this port belongs'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: security_groups
            • Description changed from '' to 'Security groups that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Deleted property: description
              • Deleted property: name
              • Deleted property: rules
              • Deleted property: state
              • Modified property: url
              • Format changed from 'uri' to ''
              • ReadOnly changed from true to false

POST /api/openstack-backups/{uuid}/restore/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: security_groups
      • Modified property: flavor
        • Description changed from '' to 'Flavor to be used for the restored instance. If not specified, original instance flavor will be used'
      • Modified property: floating_ips
        • Description changed from '' to 'Floating IPs that will be assigned to the restored instance'
      • Modified property: ports
        • Description changed from '' to 'Network ports that will be attached to the restored instance'
        • Items changed
        • Properties changed
          • Modified property: fixed_ips
          • Items changed
            • Properties changed
            • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: subnet
          • Description changed from '' to 'Subnet to which this port belongs'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: action_details
        • Description changed from '' to 'Details about ongoing or completed actions'
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this instance is located'
        • Modified property: availability_zone_name
        • Description changed from '' to 'Name of the availability zone where instance is located'
        • Modified property: backend_id
        • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: connect_directly_to_external_network
        • Description changed from '' to 'If True, instance will be connected directly to external network'
        • Modified property: flavor_name
        • Description changed from '' to 'Name of the flavor used by this instance'
        • Modified property: floating_ips
        • Description changed from '' to 'Floating IPs to assign to the instance'
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: hypervisor_hostname
        • Description changed from '' to 'Name of the hypervisor hosting this instance'
        • Modified property: ports
        • Description changed from '' to 'Network ports to attach to the instance'
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: security_groups
        • Description changed from '' to 'List of security groups to apply to the instance'
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: server_group
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OpenStackNestedServerGroup
          • Properties changed
            • Modified property: policy
            • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
        • Description changed from '' to 'Server group for instance scheduling policy'
        • Modified property: service_settings
        • Description changed from '' to 'OpenStack provider settings'
        • Modified property: tenant
        • Description changed from '' to 'The OpenStack tenant to create the instance in'
        • Modified property: tenant_uuid
        • Description changed from '' to 'UUID of the OpenStack tenant'
        • Modified property: volumes
        • Description changed from '' to 'List of volumes attached to the instance'
        • Items changed
          • Properties changed
          • Modified property: bootable
            • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
          • Modified property: image_name
            • Description changed from '' to 'Name of the image this volume was created from'
          • Modified property: type
            • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

GET /api/openstack-floating-ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: address
          • Description changed from '' to 'The public IPv4 address of the floating IP'
        • Modified property: backend_network_id
          • Description changed from '' to 'ID of network in OpenStack where this floating IP is allocated'
        • Modified property: external_address
          • Description changed from 'An optional address that maps to floating IP's address' to 'Optional address that maps to floating IP's address in external networks'
        • Modified property: port_fixed_ips
          • Items changed
          • Properties changed
            • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: tenant
          • Description changed from '' to 'OpenStack tenant this floating IP belongs to'

GET /api/openstack-floating-ips/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: address
        • Description changed from '' to 'The public IPv4 address of the floating IP'
        • Modified property: backend_network_id
        • Description changed from '' to 'ID of network in OpenStack where this floating IP is allocated'
        • Modified property: external_address
        • Description changed from 'An optional address that maps to floating IP's address' to 'Optional address that maps to floating IP's address in external networks'
        • Modified property: port_fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this floating IP belongs to'

GET /api/openstack-instance-availability-zones/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: available
          • Description changed from '' to 'Indicates whether this availability zone is available for instance provisioning'

GET /api/openstack-instance-availability-zones/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: available
        • Description changed from '' to 'Indicates whether this availability zone is available for instance provisioning'

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: action_details
          • Description changed from '' to 'Details about ongoing or completed actions'
        • Modified property: availability_zone
          • Description changed from '' to 'Availability zone where this instance is located'
        • Modified property: availability_zone_name
          • Description changed from '' to 'Name of the availability zone where instance is located'
        • Modified property: backend_id
          • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: connect_directly_to_external_network
          • Description changed from '' to 'If True, instance will be connected directly to external network'
        • Modified property: flavor_name
          • Description changed from '' to 'Name of the flavor used by this instance'
        • Modified property: floating_ips
          • Description changed from '' to 'Floating IPs to assign to the instance'
          • Items changed
          • Properties changed
            • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
            • Modified property: port_fixed_ips
            • Items changed
              • Properties changed
              • Modified property: ip_address
                • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
                • Description changed from '' to 'ID of the subnet in which to assign the IP address'
            • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
            • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: hypervisor_hostname
          • Description changed from '' to 'Name of the hypervisor hosting this instance'
        • Modified property: ports
          • Description changed from '' to 'Network ports to attach to the instance'
          • Items changed
          • Properties changed
            • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
            • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
            • Modified property: fixed_ips
            • Items changed
              • Properties changed
              • Modified property: ip_address
                • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
                • Description changed from '' to 'ID of the subnet in which to assign the IP address'
            • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
            • Modified property: security_groups
            • Items changed
              • Properties changed
              • Modified property: rules
                • Items changed
                • Properties changed
                  • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                  • Modified property: direction
                  • Property 'AllOf' changed
                    • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                  • Modified property: ethertype
                  • Property 'AllOf' changed
                    • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                  • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                  • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                  • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                  • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
            • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
            • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: security_groups
          • Description changed from '' to 'List of security groups to apply to the instance'
          • Items changed
          • Properties changed
            • Deleted property: description
            • Deleted property: name
            • Deleted property: rules
            • Deleted property: state
            • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: server_group
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OpenStackNestedServerGroup
            • Properties changed
            • Modified property: policy
              • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
          • Description changed from '' to 'Server group for instance scheduling policy'
        • Modified property: service_settings
          • Description changed from '' to 'OpenStack provider settings'
        • Modified property: tenant
          • Description changed from '' to 'The OpenStack tenant to create the instance in'
        • Modified property: tenant_uuid
          • Description changed from '' to 'UUID of the OpenStack tenant'
        • Modified property: volumes
          • Description changed from '' to 'List of volumes attached to the instance'
          • Items changed
          • Properties changed
            • Modified property: bootable
            • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
            • Modified property: image_name
            • Description changed from '' to 'Name of the image this volume was created from'
            • Modified property: type
            • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: action_details
        • Description changed from '' to 'Details about ongoing or completed actions'
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this instance is located'
        • Modified property: availability_zone_name
        • Description changed from '' to 'Name of the availability zone where instance is located'
        • Modified property: backend_id
        • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: connect_directly_to_external_network
        • Description changed from '' to 'If True, instance will be connected directly to external network'
        • Modified property: flavor_name
        • Description changed from '' to 'Name of the flavor used by this instance'
        • Modified property: floating_ips
        • Description changed from '' to 'Floating IPs to assign to the instance'
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: hypervisor_hostname
        • Description changed from '' to 'Name of the hypervisor hosting this instance'
        • Modified property: ports
        • Description changed from '' to 'Network ports to attach to the instance'
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: security_groups
        • Description changed from '' to 'List of security groups to apply to the instance'
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: server_group
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OpenStackNestedServerGroup
          • Properties changed
            • Modified property: policy
            • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
        • Description changed from '' to 'Server group for instance scheduling policy'
        • Modified property: service_settings
        • Description changed from '' to 'OpenStack provider settings'
        • Modified property: tenant
        • Description changed from '' to 'The OpenStack tenant to create the instance in'
        • Modified property: tenant_uuid
        • Description changed from '' to 'UUID of the OpenStack tenant'
        • Modified property: volumes
        • Description changed from '' to 'List of volumes attached to the instance'
        • Items changed
          • Properties changed
          • Modified property: bootable
            • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
          • Modified property: image_name
            • Description changed from '' to 'Name of the image this volume was created from'
          • Modified property: type
            • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

PATCH /api/openstack-instances/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: data_volume_type
        • Description changed from '' to 'Volume type for the data volume'
      • Modified property: data_volumes
        • Description changed from '' to 'Additional data volumes to attach to the instance'
      • Modified property: system_volume_type
        • Description changed from '' to 'Volume type for the system volume'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: action_details
        • Description changed from '' to 'Details about ongoing or completed actions'
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this instance is located'
        • Modified property: availability_zone_name
        • Description changed from '' to 'Name of the availability zone where instance is located'
        • Modified property: backend_id
        • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: connect_directly_to_external_network
        • Description changed from '' to 'If True, instance will be connected directly to external network'
        • Modified property: flavor_name
        • Description changed from '' to 'Name of the flavor used by this instance'
        • Modified property: floating_ips
        • Description changed from '' to 'Floating IPs to assign to the instance'
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: hypervisor_hostname
        • Description changed from '' to 'Name of the hypervisor hosting this instance'
        • Modified property: ports
        • Description changed from '' to 'Network ports to attach to the instance'
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: security_groups
        • Description changed from '' to 'List of security groups to apply to the instance'
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: server_group
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OpenStackNestedServerGroup
          • Properties changed
            • Modified property: policy
            • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
        • Description changed from '' to 'Server group for instance scheduling policy'
        • Modified property: service_settings
        • Description changed from '' to 'OpenStack provider settings'
        • Modified property: tenant
        • Description changed from '' to 'The OpenStack tenant to create the instance in'
        • Modified property: tenant_uuid
        • Description changed from '' to 'UUID of the OpenStack tenant'
        • Modified property: volumes
        • Description changed from '' to 'List of volumes attached to the instance'
        • Items changed
          • Properties changed
          • Modified property: bootable
            • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
          • Modified property: image_name
            • Description changed from '' to 'Name of the image this volume was created from'
          • Modified property: type
            • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

PUT /api/openstack-instances/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: data_volume_type
        • Description changed from '' to 'Volume type for the data volume'
      • Modified property: data_volumes
        • Description changed from '' to 'Additional data volumes to attach to the instance'
      • Modified property: system_volume_type
        • Description changed from '' to 'Volume type for the system volume'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: action_details
        • Description changed from '' to 'Details about ongoing or completed actions'
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this instance is located'
        • Modified property: availability_zone_name
        • Description changed from '' to 'Name of the availability zone where instance is located'
        • Modified property: backend_id
        • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: connect_directly_to_external_network
        • Description changed from '' to 'If True, instance will be connected directly to external network'
        • Modified property: flavor_name
        • Description changed from '' to 'Name of the flavor used by this instance'
        • Modified property: floating_ips
        • Description changed from '' to 'Floating IPs to assign to the instance'
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: hypervisor_hostname
        • Description changed from '' to 'Name of the hypervisor hosting this instance'
        • Modified property: ports
        • Description changed from '' to 'Network ports to attach to the instance'
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: security_groups
        • Description changed from '' to 'List of security groups to apply to the instance'
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: server_group
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OpenStackNestedServerGroup
          • Properties changed
            • Modified property: policy
            • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
        • Description changed from '' to 'Server group for instance scheduling policy'
        • Modified property: service_settings
        • Description changed from '' to 'OpenStack provider settings'
        • Modified property: tenant
        • Description changed from '' to 'The OpenStack tenant to create the instance in'
        • Modified property: tenant_uuid
        • Description changed from '' to 'UUID of the OpenStack tenant'
        • Modified property: volumes
        • Description changed from '' to 'List of volumes attached to the instance'
        • Items changed
          • Properties changed
          • Modified property: bootable
            • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
          • Modified property: image_name
            • Description changed from '' to 'Name of the image this volume was created from'
          • Modified property: type
            • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance
        • Description changed from '' to 'Instance that this backup is created from'
        • Modified property: instance_floating_ips
        • Items changed
          • Properties changed
          • Modified property: address
            • Description changed from '' to 'The public IPv4 address of the floating IP'
          • Modified property: port_fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: port_mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_ports
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • Deleted property: description
          • Deleted property: name
          • Deleted property: rules
          • Deleted property: state
          • Modified property: url
            • Format changed from 'uri' to ''
            • ReadOnly changed from true to false
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: flavor
            • Description changed from '' to 'Flavor to be used for the restored instance. If not specified, original instance flavor will be used'
          • Modified property: floating_ips
            • Description changed from '' to 'Floating IPs that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: address
              • Description changed from '' to 'The public IPv4 address of the floating IP'
              • Modified property: port_fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: port_mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: instance
            • Description changed from '' to 'Instance that is being restored from the backup'
          • Modified property: ports
            • Description changed from '' to 'Network ports that will be attached to the restored instance'
            • Items changed
            • Properties changed
              • Modified property: device_id
              • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
              • Modified property: device_owner
              • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
              • Modified property: fixed_ips
              • Items changed
                • Properties changed
                • Modified property: ip_address
                  • Description changed from '' to 'IP address to assign to the port'
                • Modified property: subnet_id
                  • Description changed from '' to 'ID of the subnet in which to assign the IP address'
              • Modified property: mac_address
              • Description changed from '' to 'MAC address of the port'
              • Modified property: security_groups
              • Items changed
                • Properties changed
                • Modified property: rules
                  • Items changed
                  • Properties changed
                    • Modified property: cidr
                    • Description changed from '' to 'CIDR notation for the source/destination network address range'
                    • Modified property: direction
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/DirectionEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                    • Deleted enum values: [ingress egress]
                    • Modified property: ethertype
                    • Property 'AllOf' changed
                      • Schemas added: #/components/schemas/EthertypeEnum
                    • Type changed from 'string' to ''
                    • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                    • Deleted enum values: [IPv4 IPv6]
                    • Modified property: from_port
                    • Description changed from '' to 'Starting port number in the range (1-65535)'
                    • Modified property: protocol
                    • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                    • Modified property: remote_group
                    • Description changed from '' to 'Remote security group that this rule references, if any'
                    • Modified property: to_port
                    • Description changed from '' to 'Ending port number in the range (1-65535)'
              • Modified property: subnet
              • Description changed from '' to 'Subnet to which this port belongs'
              • Modified property: subnet_cidr
              • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: security_groups
            • Description changed from '' to 'Security groups that will be assigned to the restored instance'
            • Items changed
            • Properties changed
              • Deleted property: description
              • Deleted property: name
              • Deleted property: rules
              • Deleted property: state
              • Modified property: url
              • Format changed from 'uri' to ''
              • ReadOnly changed from true to false

POST /api/openstack-instances/{uuid}/change_flavor/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: flavor
        • Description changed from '' to 'The new flavor to use for the instance. Flavor change can only be done when instance is stopped.'

GET /api/openstack-instances/{uuid}/floating_ips/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: address
          • Description changed from '' to 'The public IPv4 address of the floating IP'
        • Modified property: port_fixed_ips
          • Items changed
          • Properties changed
            • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: port_mac_address
          • Description changed from '' to 'MAC address of the port'
        • Modified property: subnet_cidr
          • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'

GET /api/openstack-instances/{uuid}/ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: device_id
          • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
        • Modified property: device_owner
          • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
        • Modified property: fixed_ips
          • Items changed
          • Properties changed
            • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: mac_address
          • Description changed from '' to 'MAC address of the port'
        • Modified property: security_groups
          • Items changed
          • Properties changed
            • Modified property: rules
            • Items changed
              • Properties changed
              • Modified property: cidr
                • Description changed from '' to 'CIDR notation for the source/destination network address range'
              • Modified property: direction
                • Property 'AllOf' changed
                • Schemas added: #/components/schemas/DirectionEnum
                • Type changed from 'string' to ''
                • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                • Deleted enum values: [ingress egress]
              • Modified property: ethertype
                • Property 'AllOf' changed
                • Schemas added: #/components/schemas/EthertypeEnum
                • Type changed from 'string' to ''
                • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                • Deleted enum values: [IPv4 IPv6]
              • Modified property: from_port
                • Description changed from '' to 'Starting port number in the range (1-65535)'
              • Modified property: protocol
                • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
              • Modified property: remote_group
                • Description changed from '' to 'Remote security group that this rule references, if any'
              • Modified property: to_port
                • Description changed from '' to 'Ending port number in the range (1-65535)'
        • Modified property: subnet
          • Description changed from '' to 'Subnet to which this port belongs'
        • Modified property: subnet_cidr
          • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'

POST /api/openstack-instances/{uuid}/update_allowed_address_pairs/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: allowed_address_pairs
        • Description changed from '' to 'List of allowed address pairs to set on the port. Each pair should contain 'ip_address' and optional 'mac_address'.'
      • Modified property: subnet
        • Description changed from '' to 'The subnet to update allowed address pairs for.'

POST /api/openstack-instances/{uuid}/update_ports/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: ports
        • Items changed
        • Properties changed
          • Modified property: fixed_ips
          • Items changed
            • Properties changed
            • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: subnet
          • Description changed from '' to 'Subnet to which this port belongs'

POST /api/openstack-instances/{uuid}/update_security_groups/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: security_groups
        • Description changed from '' to 'List of security groups to be assigned to the instance.'

GET /api/openstack-network-rbac-policies/

  • Modified query param: policy_type
  • Description changed from '' to 'Type of access granted - either shared access or external network access

'

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: policy_type
          • Description changed from '' to 'Type of access granted - either shared access or external network access'

HEAD /api/openstack-network-rbac-policies/

  • Modified query param: policy_type
  • Description changed from '' to 'Type of access granted - either shared access or external network access

'

GET /api/openstack-network-rbac-policies/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: policy_type
        • Description changed from '' to 'Type of access granted - either shared access or external network access'

GET /api/openstack-networks/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: is_external
          • Description changed from '' to 'Defines whether this network is external (public) or internal (private)'
        • Modified property: rbac_policies
          • Items changed
          • Properties changed
            • Modified property: policy_type
            • Description changed from '' to 'Type of access granted - either shared access or external network access'
        • Modified property: subnets
          • Items changed
          • Properties changed
            • Modified property: cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
            • Modified property: enable_dhcp
            • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
            • Modified property: gateway_ip
            • Description changed from '' to 'IP address of the gateway for this subnet'
            • Modified property: ip_version
            • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: tenant
          • Description changed from '' to 'OpenStack tenant this network belongs to'
        • Modified property: type
          • Description changed from '' to 'Network type, such as local, flat, vlan, vxlan, or gre'

GET /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_external
        • Description changed from '' to 'Defines whether this network is external (public) or internal (private)'
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • Modified property: policy_type
            • Description changed from '' to 'Type of access granted - either shared access or external network access'
        • Modified property: subnets
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: enable_dhcp
            • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
          • Modified property: gateway_ip
            • Description changed from '' to 'IP address of the gateway for this subnet'
          • Modified property: ip_version
            • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this network belongs to'
        • Modified property: type
        • Description changed from '' to 'Network type, such as local, flat, vlan, vxlan, or gre'

PATCH /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_external
        • Description changed from '' to 'Defines whether this network is external (public) or internal (private)'
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • Modified property: policy_type
            • Description changed from '' to 'Type of access granted - either shared access or external network access'
        • Modified property: subnets
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: enable_dhcp
            • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
          • Modified property: gateway_ip
            • Description changed from '' to 'IP address of the gateway for this subnet'
          • Modified property: ip_version
            • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this network belongs to'
        • Modified property: type
        • Description changed from '' to 'Network type, such as local, flat, vlan, vxlan, or gre'

PUT /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_external
        • Description changed from '' to 'Defines whether this network is external (public) or internal (private)'
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • Modified property: policy_type
            • Description changed from '' to 'Type of access granted - either shared access or external network access'
        • Modified property: subnets
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: enable_dhcp
            • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
          • Modified property: gateway_ip
            • Description changed from '' to 'IP address of the gateway for this subnet'
          • Modified property: ip_version
            • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this network belongs to'
        • Modified property: type
        • Description changed from '' to 'Network type, such as local, flat, vlan, vxlan, or gre'

POST /api/openstack-networks/{uuid}/create_subnet/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
      • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
        • Modified property: enable_dhcp
        • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
        • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
        • Modified property: ip_version
        • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: network
        • Description changed from '' to 'Network to which this subnet belongs'

POST /api/openstack-networks/{uuid}/rbac_policy_create/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: policy_type
        • Description changed from '' to 'Type of access granted - either shared access or external network access'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: policy_type
        • Description changed from '' to 'Type of access granted - either shared access or external network access'

GET /api/openstack-ports/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: admin_state_up
          • Description changed from '' to 'Administrative state of the port. If down, port does not forward packets'
        • Modified property: backend_id
          • Description changed from '' to 'Port ID in OpenStack'
        • Modified property: device_id
          • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
        • Modified property: device_owner
          • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
        • Modified property: fixed_ips
          • Items changed
          • Properties changed
            • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: mac_address
          • Description changed from '' to 'MAC address of the port'
        • Modified property: network
          • Description changed from '' to 'Network to which this port belongs'
        • Modified property: port_security_enabled
          • Description changed from '' to 'If True, security groups and rules will be applied to this port'
        • Modified property: status
          • Description changed from '' to 'Port status in OpenStack (e.g. ACTIVE, DOWN)'
        • Modified property: tenant
          • Description changed from '' to 'OpenStack tenant this port belongs to'

POST /api/openstack-ports/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: fixed_ips
        • Items changed
        • Properties changed
          • Modified property: ip_address
          • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
          • Description changed from '' to 'ID of the subnet in which to assign the IP address'
      • Modified property: mac_address
        • Description changed from '' to 'MAC address of the port'
      • Modified property: network
        • Description changed from '' to 'Network to which this port belongs'
      • Modified property: port_security_enabled
        • Description changed from '' to 'If True, security groups and rules will be applied to this port'
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Description changed from '' to 'Administrative state of the port. If down, port does not forward packets'
        • Modified property: backend_id
        • Description changed from '' to 'Port ID in OpenStack'
        • Modified property: device_id
        • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
        • Modified property: device_owner
        • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
        • Modified property: fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: mac_address
        • Description changed from '' to 'MAC address of the port'
        • Modified property: network
        • Description changed from '' to 'Network to which this port belongs'
        • Modified property: port_security_enabled
        • Description changed from '' to 'If True, security groups and rules will be applied to this port'
        • Modified property: status
        • Description changed from '' to 'Port status in OpenStack (e.g. ACTIVE, DOWN)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this port belongs to'

GET /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Description changed from '' to 'Administrative state of the port. If down, port does not forward packets'
        • Modified property: backend_id
        • Description changed from '' to 'Port ID in OpenStack'
        • Modified property: device_id
        • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
        • Modified property: device_owner
        • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
        • Modified property: fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: mac_address
        • Description changed from '' to 'MAC address of the port'
        • Modified property: network
        • Description changed from '' to 'Network to which this port belongs'
        • Modified property: port_security_enabled
        • Description changed from '' to 'If True, security groups and rules will be applied to this port'
        • Modified property: status
        • Description changed from '' to 'Port status in OpenStack (e.g. ACTIVE, DOWN)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this port belongs to'

PATCH /api/openstack-ports/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Description changed from '' to 'Administrative state of the port. If down, port does not forward packets'
        • Modified property: backend_id
        • Description changed from '' to 'Port ID in OpenStack'
        • Modified property: device_id
        • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
        • Modified property: device_owner
        • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
        • Modified property: fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: mac_address
        • Description changed from '' to 'MAC address of the port'
        • Modified property: network
        • Description changed from '' to 'Network to which this port belongs'
        • Modified property: port_security_enabled
        • Description changed from '' to 'If True, security groups and rules will be applied to this port'
        • Modified property: status
        • Description changed from '' to 'Port status in OpenStack (e.g. ACTIVE, DOWN)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this port belongs to'

PUT /api/openstack-ports/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: fixed_ips
        • Items changed
        • Properties changed
          • Modified property: ip_address
          • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
          • Description changed from '' to 'ID of the subnet in which to assign the IP address'
      • Modified property: mac_address
        • Description changed from '' to 'MAC address of the port'
      • Modified property: network
        • Description changed from '' to 'Network to which this port belongs'
      • Modified property: port_security_enabled
        • Description changed from '' to 'If True, security groups and rules will be applied to this port'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: admin_state_up
        • Description changed from '' to 'Administrative state of the port. If down, port does not forward packets'
        • Modified property: backend_id
        • Description changed from '' to 'Port ID in OpenStack'
        • Modified property: device_id
        • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
        • Modified property: device_owner
        • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
        • Modified property: fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: mac_address
        • Description changed from '' to 'MAC address of the port'
        • Modified property: network
        • Description changed from '' to 'Network to which this port belongs'
        • Modified property: port_security_enabled
        • Description changed from '' to 'If True, security groups and rules will be applied to this port'
        • Modified property: status
        • Description changed from '' to 'Port status in OpenStack (e.g. ACTIVE, DOWN)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this port belongs to'

POST /api/openstack-ports/{uuid}/update_port_ip/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: ip_address
        • Description changed from '' to 'The IP address to assign within the subnet'
      • Modified property: subnet
        • Description changed from '' to 'The subnet where the new IP address will be allocated'

POST /api/openstack-ports/{uuid}/update_security_groups/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: security_groups
        • Description changed from '' to 'List of security groups to be assigned to the instance.'

GET /api/openstack-routers/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Description changed from '' to 'Router ID in OpenStack'
        • Modified property: fixed_ips
          • Items changed
          • Properties changed
            • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
            • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: ports
          • Items changed
          • Properties changed
            • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
            • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
            • Modified property: fixed_ips
            • Items changed
              • Properties changed
              • Modified property: ip_address
                • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
                • Description changed from '' to 'ID of the subnet in which to assign the IP address'
            • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
            • Modified property: security_groups
            • Items changed
              • Properties changed
              • Modified property: rules
                • Items changed
                • Properties changed
                  • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                  • Modified property: direction
                  • Property 'AllOf' changed
                    • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                  • Modified property: ethertype
                  • Property 'AllOf' changed
                    • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                  • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                  • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                  • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                  • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
            • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
            • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: tenant
          • Description changed from '' to 'OpenStack tenant this router belongs to'

POST /api/openstack-routers/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this router belongs to'
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this router belongs to'

GET /api/openstack-routers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'Router ID in OpenStack'
        • Modified property: fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: ports
        • Items changed
          • Properties changed
          • Modified property: device_id
            • Description changed from '' to 'ID of device (instance, router etc) to which this port is connected'
          • Modified property: device_owner
            • Description changed from '' to 'Entity that uses this port (e.g. network:router_interface)'
          • Modified property: fixed_ips
            • Items changed
            • Properties changed
              • Modified property: ip_address
              • Description changed from '' to 'IP address to assign to the port'
              • Modified property: subnet_id
              • Description changed from '' to 'ID of the subnet in which to assign the IP address'
          • Modified property: mac_address
            • Description changed from '' to 'MAC address of the port'
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • Modified property: rules
              • Items changed
                • Properties changed
                • Modified property: cidr
                  • Description changed from '' to 'CIDR notation for the source/destination network address range'
                • Modified property: direction
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/DirectionEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
                  • Deleted enum values: [ingress egress]
                • Modified property: ethertype
                  • Property 'AllOf' changed
                  • Schemas added: #/components/schemas/EthertypeEnum
                  • Type changed from 'string' to ''
                  • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
                  • Deleted enum values: [IPv4 IPv6]
                • Modified property: from_port
                  • Description changed from '' to 'Starting port number in the range (1-65535)'
                • Modified property: protocol
                  • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
                • Modified property: remote_group
                  • Description changed from '' to 'Remote security group that this rule references, if any'
                • Modified property: to_port
                  • Description changed from '' to 'Ending port number in the range (1-65535)'
          • Modified property: subnet
            • Description changed from '' to 'Subnet to which this port belongs'
          • Modified property: subnet_cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this router belongs to'

POST /api/openstack-routers/{uuid}/add_router_interface/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: port
        • Description changed from '' to 'The port to connect to the router. Either subnet or port must be specified, but not both.'
      • Modified property: subnet
        • Description changed from '' to 'The subnet to connect to the router. Either subnet or port must be specified, but not both.'

POST /api/openstack-routers/{uuid}/remove_router_interface/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: port
        • Description changed from '' to 'The port to connect to the router. Either subnet or port must be specified, but not both.'
      • Modified property: subnet
        • Description changed from '' to 'The subnet to connect to the router. Either subnet or port must be specified, but not both.'

GET /api/openstack-security-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: rules
          • Items changed
          • Properties changed
            • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
            • Modified property: direction
            • Property 'AllOf' changed
              • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
            • Modified property: ethertype
            • Property 'AllOf' changed
              • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
            • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
            • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
            • Modified property: remote_group
            • Description changed from '' to 'Remote security group that this rule references, if any'
            • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

GET /api/openstack-security-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rules
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
          • Modified property: ethertype
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: remote_group
            • Description changed from '' to 'Remote security group that this rule references, if any'
          • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

POST /api/openstack-security-groups/{uuid}/set_rules/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Items changed
      • Properties changed
        • Modified property: cidr
        • Description changed from '' to 'CIDR notation for the source/destination network address range'
        • Modified property: direction
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/DirectionEnum
        • Type changed from 'string' to ''
        • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
        • Deleted enum values: [ingress egress]
        • Modified property: ethertype
        • Property 'AllOf' changed
          • Schemas added: #/components/schemas/EthertypeEnum
        • Type changed from 'string' to ''
        • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
        • Deleted enum values: [IPv4 IPv6]
        • Modified property: from_port
        • Description changed from '' to 'Starting port number in the range (1-65535)'
        • Modified property: protocol
        • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
        • Modified property: remote_group
        • Description changed from '' to 'Remote security group that this rule references, if any'
        • Modified property: to_port
        • Description changed from '' to 'Ending port number in the range (1-65535)'

GET /api/openstack-server-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instances
          • Items changed
          • Properties changed
            • Modified property: backend_id
            • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: policy
          • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'

POST /api/openstack-server-groups/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instances
        • Items changed
          • Properties changed
          • Modified property: backend_id
            • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'

GET /api/openstack-server-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instances
        • Items changed
          • Properties changed
          • Modified property: backend_id
            • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'

PATCH /api/openstack-server-groups/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instances
        • Items changed
          • Properties changed
          • Modified property: backend_id
            • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'

PUT /api/openstack-server-groups/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instances
        • Items changed
          • Properties changed
          • Modified property: backend_id
            • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'

GET /api/openstack-snapshots/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Description changed from '' to 'Snapshot ID in the OpenStack backend'
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: volume
            • Description changed from '' to 'Volume that is being restored from the snapshot'
        • Modified property: source_volume
          • Description changed from '' to 'Volume from which this snapshot was created'

GET /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'Snapshot ID in the OpenStack backend'
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: volume
            • Description changed from '' to 'Volume that is being restored from the snapshot'
        • Modified property: source_volume
        • Description changed from '' to 'Volume from which this snapshot was created'

PATCH /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'Snapshot ID in the OpenStack backend'
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: volume
            • Description changed from '' to 'Volume that is being restored from the snapshot'
        • Modified property: source_volume
        • Description changed from '' to 'Volume from which this snapshot was created'

PUT /api/openstack-snapshots/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'Snapshot ID in the OpenStack backend'
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: volume
            • Description changed from '' to 'Volume that is being restored from the snapshot'
        • Modified property: source_volume
        • Description changed from '' to 'Volume from which this snapshot was created'

GET /api/openstack-snapshots/{uuid}/restorations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: volume
          • Description changed from '' to 'Volume that is being restored from the snapshot'

POST /api/openstack-snapshots/{uuid}/restore/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this volume is located'
        • Modified property: backend_id
        • Description changed from '' to 'Volume ID in the OpenStack backend'
        • Modified property: bootable
        • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
        • Modified property: image
        • Description changed from '' to 'Image that this volume was created from, if any'
        • Modified property: image_metadata
        • Description changed from '' to 'Metadata of the image this volume was created from'
        • Modified property: image_name
        • Description changed from '' to 'Name of the image this volume was created from'
        • Modified property: instance
        • Description changed from '' to 'Instance that this volume is attached to, if any'
        • Modified property: source_snapshot
        • Description changed from '' to 'Snapshot that this volume was created from, if any'
        • Modified property: type
        • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

GET /api/openstack-subnets/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: disable_gateway
          • Description changed from '' to 'If True, no gateway IP address will be allocated'
        • Modified property: enable_dhcp
          • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
        • Modified property: gateway_ip
          • Description changed from '' to 'IP address of the gateway for this subnet'
        • Modified property: ip_version
          • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: network
          • Description changed from '' to 'Network to which this subnet belongs'

GET /api/openstack-subnets/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
        • Modified property: enable_dhcp
        • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
        • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
        • Modified property: ip_version
        • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: network
        • Description changed from '' to 'Network to which this subnet belongs'

PATCH /api/openstack-subnets/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
      • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
        • Modified property: enable_dhcp
        • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
        • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
        • Modified property: ip_version
        • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: network
        • Description changed from '' to 'Network to which this subnet belongs'

PUT /api/openstack-subnets/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
      • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: disable_gateway
        • Description changed from '' to 'If True, no gateway IP address will be allocated'
        • Modified property: enable_dhcp
        • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
        • Modified property: gateway_ip
        • Description changed from '' to 'IP address of the gateway for this subnet'
        • Modified property: ip_version
        • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: network
        • Description changed from '' to 'Network to which this subnet belongs'

GET /api/openstack-tenants/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
          • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
          • Description changed from '' to 'ID of internal network in OpenStack tenant'

POST /api/openstack-tenants/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
        • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
        • Description changed from '' to 'ID of internal network in OpenStack tenant'

GET /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
        • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
        • Description changed from '' to 'ID of internal network in OpenStack tenant'

PATCH /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
        • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
        • Description changed from '' to 'ID of internal network in OpenStack tenant'

PUT /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
        • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
        • Description changed from '' to 'ID of internal network in OpenStack tenant'

GET /api/openstack-tenants/{uuid}/backend_instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: hypervisor_hostname
          • Description changed from '' to 'Name of the hypervisor hosting this instance'

GET /api/openstack-tenants/{uuid}/backend_volumes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: backend_id
          • Description changed from '' to 'Volume ID in the OpenStack backend'
        • Modified property: bootable
          • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
        • Modified property: metadata
          • Description changed from '' to 'Arbitrary key-value pairs associated with the volume'

POST /api/openstack-tenants/{uuid}/create_floating_ip/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: address
        • Description changed from '' to 'The public IPv4 address of the floating IP'
        • Modified property: backend_network_id
        • Description changed from '' to 'ID of network in OpenStack where this floating IP is allocated'
        • Modified property: external_address
        • Description changed from 'An optional address that maps to floating IP's address' to 'Optional address that maps to floating IP's address in external networks'
        • Modified property: port_fixed_ips
        • Items changed
          • Properties changed
          • Modified property: ip_address
            • Description changed from '' to 'IP address to assign to the port'
          • Modified property: subnet_id
            • Description changed from '' to 'ID of the subnet in which to assign the IP address'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this floating IP belongs to'

POST /api/openstack-tenants/{uuid}/create_network/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: is_external
        • Description changed from '' to 'Defines whether this network is external (public) or internal (private)'
        • Modified property: rbac_policies
        • Items changed
          • Properties changed
          • Modified property: policy_type
            • Description changed from '' to 'Type of access granted - either shared access or external network access'
        • Modified property: subnets
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'IPv4 network address in CIDR format (e.g. 192.168.0.0/24)'
          • Modified property: enable_dhcp
            • Description changed from '' to 'If True, DHCP service will be enabled on this subnet'
          • Modified property: gateway_ip
            • Description changed from '' to 'IP address of the gateway for this subnet'
          • Modified property: ip_version
            • Description changed from '' to 'IP protocol version (4 or 6)'
        • Modified property: tenant
        • Description changed from '' to 'OpenStack tenant this network belongs to'
        • Modified property: type
        • Description changed from '' to 'Network type, such as local, flat, vlan, vxlan, or gre'

POST /api/openstack-tenants/{uuid}/create_security_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: rules
        • Items changed
        • Properties changed
          • Modified property: cidr
          • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
          • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
          • Type changed from 'string' to ''
          • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
          • Deleted enum values: [ingress egress]
          • Modified property: ethertype
          • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
          • Type changed from 'string' to ''
          • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
          • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
          • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
          • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: remote_group
          • Description changed from '' to 'Remote security group that this rule references, if any'
          • Modified property: to_port
          • Description changed from '' to 'Ending port number in the range (1-65535)'
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rules
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
          • Modified property: ethertype
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: remote_group
            • Description changed from '' to 'Remote security group that this rule references, if any'
          • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

POST /api/openstack-tenants/{uuid}/create_server_group/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instances
        • Items changed
          • Properties changed
          • Modified property: backend_id
            • Description changed from '' to 'Instance ID in the OpenStack backend'
        • Modified property: policy
        • Description changed from '' to 'Server group policy determining the rules for scheduling servers in this group'

POST /api/openstack-tenants/{uuid}/pull_security_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
        • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
        • Description changed from '' to 'ID of internal network in OpenStack tenant'

POST /api/openstack-tenants/{uuid}/pull_server_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'ID of tenant in the OpenStack backend'
        • Modified property: external_network_id
        • Description changed from '' to 'ID of external network connected to OpenStack tenant'
        • Modified property: internal_network_id
        • Description changed from '' to 'ID of internal network in OpenStack tenant'

GET /api/openstack-volumes/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: availability_zone
          • Description changed from '' to 'Availability zone where this volume is located'
        • Modified property: backend_id
          • Description changed from '' to 'Volume ID in the OpenStack backend'
        • Modified property: bootable
          • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
        • Modified property: image
          • Description changed from '' to 'Image that this volume was created from, if any'
        • Modified property: image_metadata
          • Description changed from '' to 'Metadata of the image this volume was created from'
        • Modified property: image_name
          • Description changed from '' to 'Name of the image this volume was created from'
        • Modified property: instance
          • Description changed from '' to 'Instance that this volume is attached to, if any'
        • Modified property: source_snapshot
          • Description changed from '' to 'Snapshot that this volume was created from, if any'
        • Modified property: type
          • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

GET /api/openstack-volumes/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this volume is located'
        • Modified property: backend_id
        • Description changed from '' to 'Volume ID in the OpenStack backend'
        • Modified property: bootable
        • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
        • Modified property: image
        • Description changed from '' to 'Image that this volume was created from, if any'
        • Modified property: image_metadata
        • Description changed from '' to 'Metadata of the image this volume was created from'
        • Modified property: image_name
        • Description changed from '' to 'Name of the image this volume was created from'
        • Modified property: instance
        • Description changed from '' to 'Instance that this volume is attached to, if any'
        • Modified property: source_snapshot
        • Description changed from '' to 'Snapshot that this volume was created from, if any'
        • Modified property: type
        • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

PATCH /api/openstack-volumes/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: bootable
        • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this volume is located'
        • Modified property: backend_id
        • Description changed from '' to 'Volume ID in the OpenStack backend'
        • Modified property: bootable
        • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
        • Modified property: image
        • Description changed from '' to 'Image that this volume was created from, if any'
        • Modified property: image_metadata
        • Description changed from '' to 'Metadata of the image this volume was created from'
        • Modified property: image_name
        • Description changed from '' to 'Name of the image this volume was created from'
        • Modified property: instance
        • Description changed from '' to 'Instance that this volume is attached to, if any'
        • Modified property: source_snapshot
        • Description changed from '' to 'Snapshot that this volume was created from, if any'
        • Modified property: type
        • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

PUT /api/openstack-volumes/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: bootable
        • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: availability_zone
        • Description changed from '' to 'Availability zone where this volume is located'
        • Modified property: backend_id
        • Description changed from '' to 'Volume ID in the OpenStack backend'
        • Modified property: bootable
        • Description changed from '' to 'Indicates if this volume can be used to boot an instance'
        • Modified property: image
        • Description changed from '' to 'Image that this volume was created from, if any'
        • Modified property: image_metadata
        • Description changed from '' to 'Metadata of the image this volume was created from'
        • Modified property: image_name
        • Description changed from '' to 'Name of the image this volume was created from'
        • Modified property: instance
        • Description changed from '' to 'Instance that this volume is attached to, if any'
        • Modified property: source_snapshot
        • Description changed from '' to 'Snapshot that this volume was created from, if any'
        • Modified property: type
        • Description changed from '' to 'Type of the volume (e.g. SSD, HDD)'

POST /api/openstack-volumes/{uuid}/attach/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: instance
        • Description changed from '' to 'Instance that this volume is attached to, if any'

POST /api/openstack-volumes/{uuid}/snapshot/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: backend_id
        • Description changed from '' to 'Snapshot ID in the OpenStack backend'
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: volume
            • Description changed from '' to 'Volume that is being restored from the snapshot'
        • Modified property: source_volume
        • Description changed from '' to 'Volume from which this snapshot was created'

GET /api/projects/{uuid}/other_users/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • Deleted required property: full_name
        • Deleted required property: url
        • Deleted required property: username
        • Deleted required property: uuid

GET /api/rancher-cluster-security-groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: rules
          • Items changed
          • Properties changed
            • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
            • Modified property: direction
            • Property 'AllOf' changed
              • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
            • Modified property: ethertype
            • Property 'AllOf' changed
              • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
            • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
            • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
            • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

GET /api/rancher-cluster-security-groups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rules
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
          • Modified property: ethertype
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

PATCH /api/rancher-cluster-security-groups/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: rules
        • Items changed
        • Properties changed
          • Modified property: cidr
          • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
          • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
          • Type changed from 'string' to ''
          • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
          • Deleted enum values: [ingress egress]
          • Modified property: ethertype
          • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
          • Type changed from 'string' to ''
          • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
          • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
          • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
          • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: to_port
          • Description changed from '' to 'Ending port number in the range (1-65535)'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rules
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
          • Modified property: ethertype
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

PUT /api/rancher-cluster-security-groups/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: rules
        • Items changed
        • Properties changed
          • Modified property: cidr
          • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
          • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
          • Type changed from 'string' to ''
          • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
          • Deleted enum values: [ingress egress]
          • Modified property: ethertype
          • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
          • Type changed from 'string' to ''
          • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
          • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
          • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
          • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: to_port
          • Description changed from '' to 'Ending port number in the range (1-65535)'
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: rules
        • Items changed
          • Properties changed
          • Modified property: cidr
            • Description changed from '' to 'CIDR notation for the source/destination network address range'
          • Modified property: direction
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/DirectionEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)'
            • Deleted enum values: [ingress egress]
          • Modified property: ethertype
            • Property 'AllOf' changed
            • Schemas added: #/components/schemas/EthertypeEnum
            • Type changed from 'string' to ''
            • Description changed from '' to 'IP protocol version - either 'IPv4' or 'IPv6''
            • Deleted enum values: [IPv4 IPv6]
          • Modified property: from_port
            • Description changed from '' to 'Starting port number in the range (1-65535)'
          • Modified property: protocol
            • Description changed from '' to 'The network protocol (TCP, UDP, ICMP, or empty for any protocol)'
          • Modified property: to_port
            • Description changed from '' to 'Ending port number in the range (1-65535)'

GET /api/user-group-invitations/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: scope_image
        • Properties changed
        • New property: is_public
        • New property: scope_image

POST /api/user-group-invitations/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: is_public
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: scope_image
      • Properties changed
        • New property: is_public
        • New property: scope_image

GET /api/user-group-invitations/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: scope_image
      • Properties changed
        • New property: is_public
        • New property: scope_image

POST /api/user-group-invitations/{uuid}/submit_request/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: scope_image
      • Properties changed
        • New property: is_public
        • New property: scope_image

GET /api/user-permission-requests/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: review_comment
          • Description changed from '' to 'Optional comment provided during review'
        • Modified property: reviewed_at
          • Description changed from '' to 'Timestamp when the review was completed'

GET /api/user-permission-requests/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: review_comment
        • Description changed from '' to 'Optional comment provided during review'
        • Modified property: reviewed_at
        • Description changed from '' to 'Timestamp when the review was completed'

OpenAPI schema diff - 7.7.7

For version 7.7.7

New Endpoints: 26

GET /api/customers/{customer_uuid}/project-metadata-compliance-details/
GET /api/customers/{customer_uuid}/project-metadata-compliance-overview/
GET /api/customers/{customer_uuid}/project-metadata-compliance-projects/
GET /api/customers/{customer_uuid}/project-metadata-question-answers/
GET /api/managed-rancher-cluster-resources/
HEAD /api/managed-rancher-cluster-resources/
GET /api/managed-rancher-cluster-resources/{uuid}/
POST /api/managed-rancher-cluster-resources/{uuid}/add_node/
GET /api/marketplace-offering-terms-of-service/
HEAD /api/marketplace-offering-terms-of-service/
POST /api/marketplace-offering-terms-of-service/
DELETE /api/marketplace-offering-terms-of-service/{uuid}/
GET /api/marketplace-offering-terms-of-service/{uuid}/
PATCH /api/marketplace-offering-terms-of-service/{uuid}/
PUT /api/marketplace-offering-terms-of-service/{uuid}/
GET /api/marketplace-user-offering-consents/
HEAD /api/marketplace-user-offering-consents/
POST /api/marketplace-user-offering-consents/
DELETE /api/marketplace-user-offering-consents/{uuid}/
GET /api/marketplace-user-offering-consents/{uuid}/
PATCH /api/marketplace-user-offering-consents/{uuid}/
PUT /api/marketplace-user-offering-consents/{uuid}/
POST /api/marketplace-user-offering-consents/{uuid}/revoke/
GET /api/remote-waldur-api/remote_resource_order_status/{resource_uuid}/
GET /api/remote-waldur-api/remote_resource_status/{resource_uuid}/
GET /api/remote-waldur-api/remote_resource_team_status/{resource_uuid}/

Deleted Endpoints: None

Modified Endpoints: 116

POST /api/backend-resources/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/booking-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
          • ReadOnly changed from true to false

GET /api/booking-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/booking-resources/

  • New query param: offering_slug
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: slug
          • ReadOnly changed from true to false

HEAD /api/booking-resources/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/booking-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/checklists-admin-questions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: dependency_logic_operator

POST /api/checklists-admin-questions/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: dependency_logic_operator
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: dependency_logic_operator

GET /api/checklists-admin-questions/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: dependency_logic_operator

PATCH /api/checklists-admin-questions/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: dependency_logic_operator
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: dependency_logic_operator

PUT /api/checklists-admin-questions/{uuid}/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • New property: dependency_logic_operator
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: dependency_logic_operator

GET /api/checklists-admin/{uuid}/questions/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: dependency_logic_operator

GET /api/customers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [organization_groups project_metadata_checklist projects users_count]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: organization_groups
        • New property: project_metadata_checklist
        • New property: projects
        • New property: users_count
        • Modified property: slug
          • ReadOnly changed from true to false

POST /api/customers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: organization_groups
        • New property: project_metadata_checklist
        • New property: projects
        • New property: users_count
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/customers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [organization_groups project_metadata_checklist projects users_count]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: organization_groups
        • New property: project_metadata_checklist
        • New property: projects
        • New property: users_count
        • Modified property: slug
        • ReadOnly changed from true to false

PATCH /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: organization_groups
        • New property: project_metadata_checklist
        • New property: projects
        • New property: users_count
        • Modified property: slug
        • ReadOnly changed from true to false

PUT /api/customers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: organization_groups
        • New property: project_metadata_checklist
        • New property: projects
        • New property: users_count
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/google-auth/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [enable_notifications]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: enable_notifications

GET /api/google-auth/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [enable_notifications]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: enable_notifications

GET /api/google-auth/{uuid}/authorize/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [enable_notifications]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: enable_notifications

GET /api/maintenance-announcements/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Required changed
        • New required property: backend_id
        • Properties changed
        • New property: backend_id

POST /api/maintenance-announcements/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: backend_id
      • Properties changed
        • New property: backend_id

GET /api/maintenance-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: backend_id
      • Properties changed
        • New property: backend_id

PATCH /api/maintenance-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: backend_id
      • Properties changed
        • New property: backend_id

PUT /api/maintenance-announcements/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • New required property: backend_id
      • Properties changed
        • New property: backend_id

GET /api/marketplace-integration-statuses/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

HEAD /api/marketplace-integration-statuses/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/marketplace-offering-files/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

HEAD /api/marketplace-offering-files/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/marketplace-offering-user-roles/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

HEAD /api/marketplace-offering-user-roles/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/marketplace-offering-users/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

HEAD /api/marketplace-offering-users/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/marketplace-orders/

  • New query param: offering_slug
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [error_traceback]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: offering_terms_of_service

HEAD /api/marketplace-orders/

  • New query param: offering_slug

POST /api/marketplace-orders/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Modified property: attributes
        • Property 'OneOf' changed
        • Schemas added: #/components/schemas/GenericOrderAttributes
        • Modified schema: #/components/schemas/AzureVirtualMachineCreateOrderAttributes
          • Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Modified schema: #/components/schemas/AzureSQLServerCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Modified schema: #/components/schemas/OpenStackTenantCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Properties changed - New property: user_password - New property: user_username - Modified schema: #/components/schemas/OpenStackInstanceCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Properties changed - Modified property: security_groups - Description changed from 'List of security groups to apply to the instance' to 'Security groups to attach to the instance' - Items changed - Properties changed - Modified property: url - Format changed from '' to 'uri' - Modified schema: #/components/schemas/OpenStackVolumeCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Modified schema: #/components/schemas/MarketplaceRancherCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Modified schema: #/components/schemas/SlurmInvoicesSlurmPackageCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Modified schema: #/components/schemas/VMwareVirtualMachineCreateOrderAttributes - Description changed from 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.' to 'This mixin allows to specify list of fields to be rendered by serializer. It expects that request is available in serializer's context.

It is disabled for nested serializers (where parent is another serializer) but remains active for list views (where parent is a ListSerializer).' - Description changed from 'Attributes structure depends on the offering type specified in the parent object' to 'Attributes structure depends on the offering type specified in the parent object. Can also be a generic object for offerings without a specific attributes schema.'

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Required changed
        • Deleted required property: offering_terms_of_service
      • Properties changed
        • Deleted property: offering_terms_of_service

GET /api/marketplace-orders/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [error_traceback]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: offering_terms_of_service

GET /api/marketplace-orders/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-plans/

  • New query param: offering_slug

HEAD /api/marketplace-plans/

  • New query param: offering_slug

GET /api/marketplace-plans/usage_stats/

  • New query param: offering_slug

HEAD /api/marketplace-plans/usage_stats/

  • New query param: offering_slug

GET /api/marketplace-provider-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
          • ReadOnly changed from true to false

POST /api/marketplace-provider-offerings/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: terms_of_service
      • Deleted property: terms_of_service_link
  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-provider-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/marketplace-provider-offerings/{uuid}/import_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/marketplace-provider-offerings/{uuid}/move_offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-provider-offerings/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: offering_terms_of_service

GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: offering_terms_of_service

POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: terms_of_service
      • Deleted property: terms_of_service_link

GET /api/marketplace-provider-offerings/{uuid}/stats/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/marketplace-provider-offerings/{uuid}/update_image/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/marketplace-provider-offerings/{uuid}/update_overview/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: terms_of_service
      • Deleted property: terms_of_service_link

GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/marketplace-provider-resources/

  • New query param: offering_slug
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service

HEAD /api/marketplace-provider-resources/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/marketplace-provider-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/marketplace-provider-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

POST /api/marketplace-provider-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/marketplace-provider-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/marketplace-public-offerings/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-public-offerings/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • Deleted enum values: [terms_of_service terms_of_service_link]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-resources/

  • New query param: offering_slug
  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service

HEAD /api/marketplace-resources/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

GET /api/marketplace-resources/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/marketplace-resources/{uuid}/details/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [user_requires_reconsent]
    • Deleted enum values: [offering_terms_of_service]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

POST /api/marketplace-resources/{uuid}/move_resource/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
        • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
          • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/marketplace-resources/{uuid}/offering/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-screenshots/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

HEAD /api/marketplace-screenshots/

  • New query param: offering_slug
  • Modified query param: offering_uuid
  • Description changed from '' to 'Multiple values may be separated by commas.'
  • Style changed from '' to 'form'
  • Explode changed from null to false
  • Schema changed
    • Type changed from 'string' to 'array'
    • Format changed from 'uuid' to ''
    • Items changed
    • Schema added

POST /api/marketplace-script-dry-run/{uuid}/async_run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

POST /api/marketplace-script-dry-run/{uuid}/run/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Deleted property: terms_of_service
        • Deleted property: terms_of_service_link

GET /api/marketplace-service-providers/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [enable_notifications]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: enable_notifications

POST /api/marketplace-service-providers/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: enable_notifications

GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: slug
          • ReadOnly changed from true to false

GET /api/marketplace-service-providers/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [enable_notifications]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: enable_notifications

PATCH /api/marketplace-service-providers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: enable_notifications

PUT /api/marketplace-service-providers/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: enable_notifications

GET /api/openstack-backups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: instance_security_groups
          • Items changed
          • Properties changed
            • New property: description
            • New property: name
            • New property: rules
            • New property: state
            • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true
        • Modified property: restorations
          • Items changed
          • Properties changed
            • Modified property: security_groups
            • Items changed
              • Properties changed
              • New property: description
              • New property: name
              • New property: rules
              • New property: state
              • Modified property: url
                • Format changed from '' to 'uri'
                • ReadOnly changed from false to true

GET /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • New property: description
              • New property: name
              • New property: rules
              • New property: state
              • Modified property: url
              • Format changed from '' to 'uri'
              • ReadOnly changed from false to true

PATCH /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • New property: description
              • New property: name
              • New property: rules
              • New property: state
              • Modified property: url
              • Format changed from '' to 'uri'
              • ReadOnly changed from false to true

PUT /api/openstack-backups/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • New property: description
              • New property: name
              • New property: rules
              • New property: state
              • Modified property: url
              • Format changed from '' to 'uri'
              • ReadOnly changed from false to true

POST /api/openstack-backups/{uuid}/restore/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Properties changed
      • Deleted property: security_groups
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true

GET /api/openstack-instances/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: security_groups
          • Items changed
          • Properties changed
            • New property: description
            • New property: name
            • New property: rules
            • New property: state
            • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true

GET /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true

PATCH /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true

PUT /api/openstack-instances/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true

POST /api/openstack-instances/{uuid}/backup/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: instance_security_groups
        • Items changed
          • Properties changed
          • New property: description
          • New property: name
          • New property: rules
          • New property: state
          • Modified property: url
            • Format changed from '' to 'uri'
            • ReadOnly changed from false to true
        • Modified property: restorations
        • Items changed
          • Properties changed
          • Modified property: security_groups
            • Items changed
            • Properties changed
              • New property: description
              • New property: name
              • New property: rules
              • New property: state
              • Modified property: url
              • Format changed from '' to 'uri'
              • ReadOnly changed from false to true

GET /api/openstack-networks/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [segmentation_id]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: segmentation_id

GET /api/openstack-networks/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [segmentation_id]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: segmentation_id

PATCH /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: segmentation_id

PUT /api/openstack-networks/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: segmentation_id

POST /api/openstack-security-groups/{uuid}/set_rules/

  • Request body changed
  • Content changed
    • Modified media type: application/json
    • Schema changed
      • Items changed
      • Properties changed
        • Modified property: direction
        • Default changed from null to 'ingress'
        • Modified property: ethertype
        • Default changed from null to 'IPv4'

GET /api/openstack-tenants/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [access_url user_password user_username]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

POST /api/openstack-tenants/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

GET /api/openstack-tenants/{uuid}/

  • Modified query param: field
  • Schema changed
    • Items changed
    • New enum values: [access_url user_password user_username]
  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

PATCH /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

PUT /api/openstack-tenants/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

POST /api/openstack-tenants/{uuid}/create_network/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: segmentation_id

POST /api/openstack-tenants/{uuid}/pull_security_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

POST /api/openstack-tenants/{uuid}/pull_server_groups/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • New property: access_url
        • New property: user_password
        • New property: user_username

GET /api/promotions-campaigns/{uuid}/orders/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Deleted property: offering_terms_of_service

GET /api/promotions-campaigns/{uuid}/resources/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • New property: user_requires_reconsent
        • Deleted property: offering_terms_of_service
        • Modified property: creation_order
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service
        • Modified property: order_in_progress
          • Property 'AllOf' changed
          • Modified schema: #/components/schemas/OrderDetails
            • Properties changed
            • Deleted property: offering_terms_of_service

GET /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: slug
          • ReadOnly changed from true to false

POST /api/proposal-protected-calls/

  • Responses changed
  • Modified response: 201
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

PATCH /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

PUT /api/proposal-protected-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/proposal-protected-calls/{uuid}/activate/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/proposal-protected-calls/{uuid}/archive/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

GET /api/proposal-public-calls/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Items changed
        • Properties changed
        • Modified property: slug
          • ReadOnly changed from true to false

GET /api/proposal-public-calls/{uuid}/

  • Responses changed
  • Modified response: 200
    • Content changed
    • Modified media type: application/json
      • Schema changed
      • Properties changed
        • Modified property: slug
        • ReadOnly changed from true to false

Ended: API Changes

Ended: APIs

Allocation Lifecycle Management by Service Provider

This page describes operations to be performed by service provider.

Prerequisites

Please, read initial setup for Waldur SDK.

Getting a list of users

list_users method is used to fetch all users in a Waldur instance.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# The sync function from users_list module is used to fetch all users
from waldur_api_client.api.users import users_list

# Initialize your client first (per the SDK guide)
result = users_list.sync(client=client)

# The result will be a list of User objects with the following attributes:
# - url: str
# - uuid: UUID
# - username: str
# - slug: str
# - full_name: str
# - native_name: str
# - job_title: str
# - email: str
# - phone_number: str
# - organization: str
# - civil_number: str
# - description: str
# - is_staff: bool
# - is_active: bool
# - is_support: bool
# - token: str
# - token_lifetime: int
# - registration_method: str
# - date_joined: datetime
# - agreement_date: datetime
# - preferred_language: str
# - permissions: list[Permission]
# - requested_email: str
# - affiliations: Any
# - first_name: str
# - last_name: str
# - identity_provider_name: str
# - identity_provider_label: str
# - identity_provider_management_url: str
# - identity_provider_fields: list[str]
# - image: str
# - identity_source: str
# - has_active_session: bool

Getting a list of SSH keys

keys_list method is used to fetch all SSH keys in Waldur.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.api.keys import keys_list

# List all SSH keys
result = keys_list.sync(client=client)

# The result will be a list of SshKey objects with the following attributes:
# - url: str
# - uuid: UUID
# - name: str
# - public_key: str
# - fingerprint_md5: str
# - fingerprint_sha256: str
# - fingerprint_sha512: str
# - user_uuid: UUID
# - is_shared: bool
# - type_: str

Getting a list of resource allocations

marketplace_resources_list method is used to fetch resources related to offerings, which belong to user's service provider.

Possible filter options for allocations (each one is optional):

  • provider_uuid - UUID of a service provider organization;
  • state - current state of a resource allocation; for valid values please use the associated enum values from MarketplaceResourcesListStateItem;
  • offering_uuid - UUID of a related resource;
  • fields - list of fields to return (can be passed as as strings or imported from MarketplaceResourcesListFieldItem enum, which includes fields like name, offering, state, limits, plan, project, url, and many others). Both examples are provided:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
from waldur_api_client.models.marketplace_resources_list_state_item import MarketplaceResourcesListStateItem
from waldur_api_client.models.marketplace_resources_list_field_item import MarketplaceResourcesListFieldItem
from waldur_api_client.api.marketplace_resources import marketplace_resources_list

result = marketplace_resources_list.sync(
    client=client,
    provider_uuid='<provider-uuid>',
    state=[MarketplaceResourcesListStateItem.CREATING],
    offering_uuid='<offering-uuid>',
    field=[
        MarketplaceResourcesListFieldItem.NAME,
        MarketplaceResourcesListFieldItem.STATE,
        MarketplaceResourcesListFieldItem.LIMITS,
        MarketplaceResourcesListFieldItem.PLAN,
        MarketplaceResourcesListFieldItem.PROJECT,
        MarketplaceResourcesListFieldItem.URL
    ]
)


# The result will be a list of Resource objects with the following fields:
# - name: str
# - offering: str
# - state: ResourceState
# - limits: ResourceLimits
# - plan: str
# - project: str
# - url: str

Approving/rejecting allocation order by service provider

The service provider can either approve or reject order using marketplace_orders_approve_by_provider and marketplace_orders_reject_by_provider correspondingly. Both of these methods expect as its only argument UUID of an order for the allocation.

For example, a consumer requested an allocation using Order with CREATE type. After that, an empty allocation with CREATING state has appeared. A service provider can change the state to ok (created successfully) using marketplace_orders_approve_by_provider or rejected (creation rejected) using marketplace_orders_reject_by_provider. In order to get a proper order, SP owner can use marketplace_orders_list method. This action is for order listing and supports filtering by state and allocation.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
from waldur_api_client.api.marketplace_orders import (
    marketplace_orders_approve_by_provider,
    marketplace_orders_reject_by_provider, 
    marketplace_orders_list,
    MarketplaceOrdersListStateItem
)
from waldur_api_client.models.marketplace_orders_list_state_item import MarketplaceOrdersListStateItem

# Service providers can approve or reject orders using:
marketplace_orders_approve_by_provider.sync(
    uuid="<order-uuid>",
    client=client
)
marketplace_orders_reject_by_provider.sync(
    uuid="<order-uuid>",
    client=client
)

# To retreive orders with state "executing" with a specific resource uuid
orders = marketplace_orders_list.sync(
    client=client,
    state=[MarketplaceOrdersListStateItem.EXECUTING],  # List of order states to filter by
    resource_uuid="<resource-uuid>"  # Optional filter by specific resource
)

# Example workflow:
# 1. Get pending orders
orders = marketplace_orders_list.sync(
    client=client,
    state=[MarketplaceOrdersListStateItem.EXECUTING]
)

# 2. Approve orders
for order in orders:
    marketplace_orders_approve_by_provider.sync(
        uuid=order.uuid,
        client=client
    )

# Available order states can be viewed in client's MarketplaceOrdersListStateItem, supported order states:
# - "canceled"
# - "done"
# - "erred"
# - "executing"
# - "pending-consumer"
# - "pending-project"
# - "pending-provider"
# - "rejected"

Cancellation of orders for allocations

A consumer can also cancel created order and subsequently interrupt the requested operation over allocation. For example, this option is suitable if the customer wants to cancel allocation deletion. For this, marketplace_orders_cancel method should be used. It changes the state of the order to canceled. NB: this transition is possible only if the order's state is equal to pending-consumer or pending-provider and offering type is basic or support.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.api.marketplace_orders import marketplace_orders_list, marketplace_orders_cancel
from waldur_api_client.models.marketplace_orders_list_state_item import MarketplaceOrdersListStateItem
from waldur_api_client.models.marketplace_orders_list_type_item import MarketplaceOrdersListTypeItem

# List orders
orders = marketplace_orders_list.sync(
    client=client,
    state=[MarketplaceOrdersListStateItem.EXECUTING],
    type_=[MarketplaceOrdersListTypeItem.TERMINATE]
)

order = orders[0]

result = marketplace_orders_cancel.sync_detailed(
    client=client,
    uuid=order.uuid
)

Updating resource allocation with local reference (setting backend_id field)

Each allocation can have a link to a service provider's internal reference using backend_id field. Only users with service provider owner and manager roles can set this value using marketplace_provider_resources_set_backend_id method of the client. It requires the following arguments:

  • uuid - UUID of a resource allocation;
  • body - A request parameter of type ResourceBackendIDRequest that contains the backend_id field, which is the unique identifier of the resource in the external system.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_backend_id
from waldur_api_client.models import ResourceBackendIDRequest

# Set backend ID for a resource
result = marketplace_provider_resources_set_backend_id.sync_detailed(
    uuid="resource-uuid",  # The UUID of the resource
    client=client,
    body=ResourceBackendIDRequest(
        backend_id="some-backend-id"  # The new backend ID
    )
)

# The response will contain a ResourceBackendID object with the updated backend_id

In case if SDK usage is not possible, HTTP request can be sent:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST <API-URL>/marketplace-resources/<resource-uuid>/

{
    "backend_id": "<some-backend-id>"
}

<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

{
    "status": "Resource backend_id has been changed."
}

Providing additional access detail for resource allocation

For additional details related to allocation access, report data is used. In order to provide this information, owners and managers can use marketplace_resource_submit_report method. It requires the following arguments:

  • uuid - UUID of a resource allocation;
  • report - A list of ReportSectionRequest instances that is wrapped in a ResourceReportRequest object. Each ReportSectionRequest contains a header and body content. The ResourceReportRequest serves as a container for these report sections when submitting the report to the API.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.models import ReportSectionRequest, ResourceReportRequest
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_submit_report

report = [
    ReportSectionRequest(header="Header1", body="Body1"),
    ReportSectionRequest(header="Header2", body="Body2")
]

report_request = ResourceReportRequest(report=report)

result = marketplace_provider_resources_submit_report.sync(
    uuid="your-resource-uuid",
    body=report_request
)

# The result will be a ResourceReport object containing:
# - `report`: List of `ReportSection` objects, each with:
#   - `header`: The section header
#   - `body`: The section content

Pagination

The Waldur API Client SDK supports pagination for list endpoints using page and page_size parameters.

Example paginating API results

1
2
3
4
5
6
7
8
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list

# Get first page with 10 items
result = marketplace_provider_offerings_list.sync(
    client=client,
    page=1,
    page_size=10
)

Filtering API Response Fields Using Enum Types

The marketplace_service_providers_list endpoint allows you to specify which fields you want to retrieve from the service provider objects. This is done using the field parameter with enum values from MarketplaceServiceProvidersListFieldItem. The field parameter is present for different API endpoints to allow selective retrieval of specific fields from the response objects.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_list
from waldur_api_client.models.marketplace_service_providers_list_field_item import (
    MarketplaceServiceProvidersListFieldItem,
)


# List service providers with specific fields
result = marketplace_service_providers_list.sync(
    client=client,
    field=[
        MarketplaceServiceProvidersListFieldItem.CUSTOMER_NAME,
        MarketplaceServiceProvidersListFieldItem.CUSTOMER_ABBREVIATION,
        MarketplaceServiceProvidersListFieldItem.DESCRIPTION,
        MarketplaceServiceProvidersListFieldItem.OFFERING_COUNT,
    ]
)
# Result will contain only the data for specified fields for each service provider.

Getting a list of members in a project with active resource allocations

Service provider owners and managers can list project members using a resource allocation with marketplace_resources_team_list method. It requires the following arguments:

  • resource_uuid - UUID of a resource allocation.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.api.marketplace_resources import marketplace_resources_team_list

# Get team members for a marketplace resource
team = marketplace_resources_team_list.sync(
    uuid="resource_uuid",
    client=client
)

# Each team member is a ProjectUser object with these fields:
# - url: str
# - uuid: UUID
# - username: str
# - full_name: str
# - role: str
# - expiration_time: Optional[datetime]
# - offering_user_username: Optional[str]
# - email: Optional[str]

Reporting usage for a resource allocation

A usage of a resource allocation can be submitted by a corresponding service provider. For this, the following methods are used:

  • marketplace_public_offerings_retrieve - getting offering with components info. Arguments:

  • offering_uuid - UUID of an offering

  • marketplace_resources_plan_periods_list - getting current plan periods for resource allocation. Arguments:

  • resource_uuid - UUID of a resource

  • marketplace_plan_components_list - retrieves the list of components for a specific offering. Arguments:

  • offering_uuid - UUID of the offering to get components for

  • client - API client instance

  • marketplace_component_usages_set_usage - creates or updates component usage for the current plan. Arguments:

  • body - parameter of type ComponentUsageCreateRequest containing:
    • resource_uuid - UUID of the resource
    • usages - list of ComponentUsage instances
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
from waldur_api_client.api.marketplace_public_offerings import marketplace_public_offerings_retrieve
from waldur_api_client.api.marketplace_plan_components import marketplace_plan_components_list
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_set_usage
from waldur_api_client.api.marketplace_resources import marketplace_resources_plan_periods_list
from waldur_api_client.models import ComponentUsageCreateRequest, ComponentUsageItemRequest 

# Get offering details
offering = marketplace_public_offerings_retrieve.sync(
    uuid='<offering-uuid>',
    client=client
)

# Get components
components = marketplace_plan_components_list.sync(
    offering_uuid='<offering-uuid>',
    client=client
)

# Create component usages
component_usages = [
    ComponentUsageItemRequest(
        type_=component.component_name,
        amount="10",
        description='Usage'
    )
    for component in components
]

# Submit usages
marketplace_component_usages_set_usage.sync(
    client=client,
    body=ComponentUsageCreateRequest(
        resource="<resource-uuid>,
        usages=component_usages
    )
)

# Get plan periods
plan_periods = marketplace_resources_plan_periods_list.sync(
    uuid='<resource-uuid>',
    client=client
)

# plan_periods:
# [{
#     'components': [{
#         'created': '2021-08-11T15:36:45.562440Z',
#         'date': '2021-08-11T15:37:30.556830Z',
#         'description': 'Usage',
#         'measured_unit': 'units',
#         'name': 'CPU',
#         'type_': 'cpu',
#         'usage': 10,
#         'uuid': 'some-uuid'
#     }],
#     'end': None,
#     'plan_name': 'sample-plan',
#     'plan_uuid': 'uuid',
#     'start': '2021-08-11T15:20:25.762775Z',
#     'uuid': 'uuid'
# }]

Granting user access to resource

An access to a resource can be granted by service provider for a particular user with specification of username. A result is represented by triplet [user, resource, username]. For this purpose, marketplace_offering_users_create should be invoked. This method requires the following arguments:

  • marketplace_offering_users_create - creates a new offering user mapping. Arguments:
  • body - parameter of type OfferingUserRequest containing:
    • offering - URL of the target offering
    • user - URL of the target user
    • username - username to be associated with the user in the offering context
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_create
from waldur_api_client.models import OfferingUserRequest

# Create offering user
result = marketplace_offering_users_create.sync(
    client=client,
    body=OfferingUserRequest(
        user='<user-url>',
        offering='<offering-url>',
        username='<username>'
    )
)

# result => {
#  'created': '2021-08-12T15:22:18.993586Z',
#  'offering': 'offering_url',
#  'offering_name': 'offering_name',
#  'offering_uuid': '<offering-uuid>',
#  'user': 'user_url',
#  'user_uuid': '<user-uuid>',
#  'username': 'user_username'
# }

In case if SDK usage is not possible, HTTP request can be sent:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
POST <API-URL>/marketplace-offering-users/

{
    "offering": "<offering-url>",
    "user": "<user-url>",
    "username": "<username>"
}

<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

{
    "created": "2021-08-12T15:22:18.993586Z",
    "offering": "offering_url",
    "offering_name": "offering_name",
    "offering_uuid": "<offering-uuid>",
    "user": "user_url",
    "user_uuid": "<user-uuid>",
    "username": "user_username"
}

Granting user access to corresponding resources in batch manner

A service provider can grant access mentioned in the previous section to all resources used in projects including a target user. For such access creation or update, marketplace_service_providers_set_offerings_username is used. The method requires the following arguments:

  • marketplace_service_providers_set_offerings_username - sets or updates the username for a user across all offerings of a service provider. Arguments:
  • uuid - UUID of the service provider
  • body - parameter of type SetOfferingsUsernameRequest containing:
    • user_uuid - UUID of the target user
    • username - new username to be set for the user across all offerings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_set_offerings_username
from waldur_api_client.models import SetOfferingsUsernameRequest

result = marketplace_service_providers_set_offerings_username.sync(
    uuid='<service-provider-uuid>',
    client=client,
    body=SetOfferingsUsernameRequest(
        user_uuid=UUID('<user-uuid>'),
        username='<username>'
    )
)
# result =>  {
#  'detail': 'Offering users have been set.'
# }

Getting service provider for an organization

A user can get service provider details using marketplace_service_providers_list with corresponding filter. This method is guaranteed to return a list with at most one service provider record.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_list
from waldur_api_client.models.marketplace_service_providers_list_field_item import MarketplaceServiceProvidersListFieldItem

# List service providers
result = marketplace_service_providers_list.sync(
    client=client,
    customer_uuid="uuid"
)

# Result will be a list of ServiceProvider objects with fields:

# 'created': '2021-09-24T13:42:05.448269Z'
# 'customer': '<customer>'
# 'customer_abbreviation': '<customer_abbreviation>'
# 'customer_country': '<customer_country>'
# 'customer_image': '<customer_image_url>'
# 'customer_name': '<customer_name>'
# 'customer_native_name': '<customer_native_name>'
# 'customer_slug': '<customer_slug>'
# 'customer_uuid': '<customer_uuid>'
# 'description': '<description>'
# 'image': '<image_url>'
# 'offering_count': 5
# 'organization_groups': []  
# 'url': '<service_provider_url>'
# 'uuid': '<service_provider_uuid>'

Listing users of service provider's resources

A service provider owner can list users currently using its resources. For this, marketplace_service_providers_users_list should be used. It accepts service_provider_uuid, which can be fetched using marketplace_service_providers_list.

  • marketplace_service_providers_users_list - retrieves a list of users associated with a service provider's resources. Arguments:
  • service_provider_uuid - UUID of the service provider
  • client - API client instance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_users_list
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_list


# First, get the service provider UUID (as shown in your example)
service_providers = marketplace_service_providers_list.sync(
    client=client,
    customer_uuid="<customer_uuid>"
)
service_provider = service_providers[0]
service_provider_uuid = service_provider.uuid

# List users of the service provider
result = marketplace_service_providers_users_list.sync(
    service_provider_uuid=service_provider_uuid,
    client=client,
)

# The response will be a list of MarketplaceServiceProviderUser objects with fields:
# uuid: UUID
# username: str
# full_name: str
# first_name: str
# last_name: str
# organization: str
# email: str
# phone_number: str
# projects_count: int
# registration_method: str
# affiliations: Any
# is_active: bool
# additional_properties: dict[str, Any]

Listing ssh key for users of service provider's resources

A service provider owner can list ssh keys of users currently using its resources. For this, list_service_provider_ssh_keys should be used. It accepts service_provider_uuid, which can be fetched using marketplace_service_providers_list.

  • marketplace_service_providers_keys_list - retrieves a list of SSH keys associated with users of a service provider's resources. Arguments:
  • service_provider_uuid - UUID of the service provider
  • client - API client instance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
from waldur_api_client.api.marketplace_service_providers import (
    marketplace_service_providers_list,
    marketplace_service_providers_keys_list,
)
service_providers = marketplace_service_providers_list.sync(
    client=client,
    customer_uuid="<customer_uuid>"
)
service_provider = service_providers[0]
service_provider_uuid = service_provider.uuid

# List SSH keys of service provider users
result = marketplace_service_providers_keys_list.sync(
    service_provider_uuid=service_provider_uuid,
    client=client,
)

# Reulst will be a list of SshKey objects with fields:
# url: str
# uuid: UUID
# name: str
# public_key: str
# fingerprint_md5: str
# fingerprint_sha256: str
# fingerprint_sha512: str
# user_uuid: UUID
# is_shared: bool
# type_: str

Listing projects with service provider's resources

A service provider owner can list all projects, which have its resources. For this, list_service_provider_projects should be used. It accepts service_provider_uuid, which can be fetched using marketplace_service_providers_list.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
from waldur_api_client.api.marketplace_service_providers import (
    marketplace_service_providers_list,
    marketplace_service_providers_projects_list,
)

service_providers = marketplace_service_providers_list.sync(
    client=client,
    customer_uuid="<customer_uuid>"
)
service_provider = service_providers[0]
service_provider_uuid = service_provider.uuid

projects = marketplace_service_providers_projects_list.sync(
    service_provider_uuid=service_provider_uuid,
    client=client,
)

# url: str
# uuid: UUID
# name: str
# slug: str
# customer: str
# customer_uuid: UUID
# customer_name: str
# customer_slug: str
# customer_native_name: str
# customer_abbreviation: str
# description: str
# created: datetime.datetime
# type_: str
# type_name: str
# type_uuid: UUID
# backend_id: str
# start_date: datetime.date
# end_date: datetime.date
# end_date_requested_by: str
# oecd_fos_2007_code: OecdFos2007CodeEnum
# oecd_fos_2007_label: str
# is_industry: bool
# image: str
# resources_count: int
# project_credit: float
# marketplace_resource_count: ProjectMarketplaceResourceCount
# billing_price_estimate: NestedPriceEstimate

Listing project permissions in projects using service provider's resources

A service provider owner can also list all active projects permissions in projects, which have its resources. For this, marketplace_service_providers_project_permissions_list should be used. It accepts service_provider_uuid, which can be fetched using marketplace_service_providers_list.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
from waldur_api_client.api.marketplace_service_providers import (
    marketplace_service_providers_list,
    marketplace_service_providers_project_permissions_list,
)

service_providers = marketplace_service_providers_list.sync(
    client=client,
    customer_uuid="<customer_uuid>"
)
service_provider = service_providers[0]
service_provider_uuid = service_provider.uuid

permissions = marketplace_service_providers_project_permissions_list.sync(
    service_provider_uuid=service_provider_uuid,
    client=client
)

# created: datetime.datetime
# expiration_time: datetime.datetime | None
# created_by: str | None
# created_by_full_name: str
# created_by_username: str
# project: str
# project_uuid: UUID
# project_name: str
# project_created: datetime.datetime
# project_end_date: datetime.datetime
# customer_uuid: UUID
# customer_name: str
# role: str
# role_name: str
# user: str
# user_full_name: str
# user_native_name: str
# user_username: str
# user_uuid: UUID
# user_email: str

Creating Offerings

Service providers can create new offerings using the Waldur SDK. The following example demonstrates how to create a new offering with components and plans.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
import os
import uuid
from uuid import UUID

from waldur_api_client import AuthenticatedClient
from waldur_api_client.api.customers import customers_list, customers_retrieve
from waldur_api_client.api.marketplace_categories import (
    marketplace_categories_list,
    marketplace_categories_retrieve,
)
from waldur_api_client.api.marketplace_provider_offerings import (
    marketplace_provider_offerings_activate,
    marketplace_provider_offerings_create,
)
from waldur_api_client.errors import UnexpectedStatus
from waldur_api_client.models.base_provider_plan_request import BaseProviderPlanRequest
from waldur_api_client.models.billing_type_enum import BillingTypeEnum
from waldur_api_client.models.billing_unit import BillingUnit
from waldur_api_client.models.country_enum import CountryEnum
from waldur_api_client.models.limit_period_enum import LimitPeriodEnum
from waldur_api_client.models.offering_component_request import OfferingComponentRequest
from waldur_api_client.models.offering_create_request import OfferingCreateRequest
from waldur_api_client.models.customer import Customer
from waldur_api_client.models.marketplace_category import MarketplaceCategory


def is_uuid_like(value: str | UUID) -> bool:
    """
    Check if value looks like a valid UUID.

    Args:
        value: Value to check, can be string or UUID

    Returns:
        bool: True if value is a valid UUID, False otherwise
    """
    if isinstance(value, UUID):
        return True
    try:
        uuid.UUID(str(value))
    except (TypeError, ValueError, AttributeError):
        return False
    else:
        return True


def get_category(
    client: AuthenticatedClient, category_identifier: str | UUID
) -> MarketplaceCategory:
    """
    Get category object from identifier (name or UUID).
    """
    if is_uuid_like(category_identifier):
        category = marketplace_categories_retrieve.sync(
            client=client, uuid=category_identifier
        )
        if category is None:
            raise ValueError(f"Category with UUID '{category_identifier}' not found")
        return category
    else:
        categories = marketplace_categories_list.sync(
            client=client, title=category_identifier
        )
        if not categories:
            raise ValueError(f"Category with name '{category_identifier}' not found")
        return categories[0]


def get_provider(
    client: AuthenticatedClient, provider_identifier: str | UUID
) -> Customer:
    """
    Get provider (customer) object from identifier (name or UUID).
    """
    if is_uuid_like(provider_identifier):
        provider = customers_retrieve.sync(
            client=client, uuid=UUID(str(provider_identifier))
        )
        if provider is None:
            raise ValueError(f"Provider with UUID '{provider_identifier}' not found")
        return provider
    else:
        providers = customers_list.sync(client=client, name=provider_identifier)
        if not providers:
            raise ValueError(f"Provider with name '{provider_identifier}' not found")
        return providers[0]


def create_offering(
    client: AuthenticatedClient,
    provider_identifier: str | UUID,
    category_identifier: str | UUID,
    name: str,
    type_: str,
    **kwargs,
) -> UUID:
    """
    Create a new offering for an organization.

    Required arguments:
        client: Authenticated client instance
        provider_identifier: Provider name or UUID
        category_identifier: Category name or UUID
        name: Name of the offering
        type_: Type of the offering

    Optional arguments (pass as kwargs):
        description: Short description of the offering
        full_description: Detailed description
        terms_of_service: Terms of service text
        terms_of_service_link: Link to terms of service
        privacy_policy_link: Link to privacy policy
        access_url: Public access URL
        vendor_details: Vendor information
        getting_started: Getting started guide
        integration_guide: Integration guide
        shared: Whether the offering is shared with all customers
        billable: Whether the offering is billable
        country: Country where the offering is available
        components: List of offering components
        plans: List of offering plans
    """

    # Get provider and category objects
    provider = get_provider(client, provider_identifier)
    category = get_category(client, category_identifier)

    # Create the offering request
    offering_request = OfferingCreateRequest(
        name=name, category=category.url, type_=type_, customer=provider.url, **kwargs
    )

    try:
        response = marketplace_provider_offerings_create.sync(
            client=client,
            body=offering_request,
        )
    except UnexpectedStatus as e:
        print(f"Error creating offering: {e}")
        raise e

    if response is None:
        raise Exception("Failed to create offering - no response received")

    return response.uuid


# Example usage:
if __name__ == "__main__":
    # Note, requires the waldur-api-client package to be installed.
    # Environment variables should be set in the environment. Example of environment variables:
    # WALDUR_API_URL=https://hpcservicehub.eu
    # WALDUR_API_TOKEN=1234567890 ( your token from waldur instance with access to organization )

    api_url = os.getenv("WALDUR_API_URL")
    api_token = os.getenv("WALDUR_API_TOKEN")

    if not api_url or not api_token:
        print(
            "Required environment variables not set. Please set WALDUR_API_URL and WALDUR_API_TOKEN"
        )
        exit(1)

    # Initialize the client
    client = AuthenticatedClient(
        base_url=os.getenv("WALDUR_API_URL"),
        token=os.getenv("WALDUR_API_TOKEN"),
        raise_on_unexpected_status=True,
    )

    # Create a component
    component = OfferingComponentRequest(
        type_="cpu",
        name="CPU",
        measured_unit="hours",
        billing_type=BillingTypeEnum.FIXED,
        limit_period=LimitPeriodEnum.MONTH,
        limit_amount=1000,
    )

    # Create a plan
    plan = BaseProviderPlanRequest(
        name="Basic Plan",
        unit_price="10",
        unit=BillingUnit.HOUR,
    )

    try:
        # Create the offering using names instead of UUIDs
        offering_uuid = create_offering(
            client=client,
            provider_identifier="My Org Name",  # Insert the organization name or UUID
            category_identifier="HPC",  # Insert the category name or UUID
            name="New Offering",  # Name of the offering
            type_="Marketplace.Basic",  # Type of the offering
            description="Offering description",
            components=[component],  # List of components
            plans=[plan],  # List of plans
            shared=True,
            billable=True,
            country=CountryEnum.FR,  # France
        )

        print(f"Created offering with UUID: {offering_uuid}")

        # Activate the offering
        print(f"Activating offering with UUID: {offering_uuid}")
        marketplace_provider_offerings_activate.sync(
            client=client,
            uuid=offering_uuid,
        )
        print(f"Offering activated with UUID: {offering_uuid}")
    except (UnexpectedStatus, ValueError) as e:
        print(f"Error: {str(e)}")

Ended: SDK Examples

VPNaaS custom script - Provisioning VPN as a Service based on Firezone

Firezone login screen

This python script provisions VPN as a Service based on Firezone in OpenStack in Waldur. It uses Flatcar Linux and a butane binary that the user needs to provide inside a Docker container used for running Waldur custom scripts.

An additional requirement is an OpenID Connect provider for end-user authentication in Firezone. Default VPN port: UDP/51820.

System requirements

  • Keycloak with admin access for OpenID Connect client creation
  • Butane for converting Flarcar Linux yaml config into json
  • OpenStack nova for running the Firezone VM
  • OpenStack designate for the VM FQDN generation. Firezone will use that FQDN for HTTPS certificate generation.

Firezone VM needs Internet connection for Let's Encrypt certificate generation and Github access for script download.

Setup guide

  1. Prepare waldur custom script runner container to have Butane and required Python packages
  2. Paste the create.py into the creation script and terminate.py into the termination script
  3. Populate environment variables
  4. Add user input field with internal name "tenant" and type - "Select OpenStack tenant", make it a required field

Environment Variables

The following environment variables need to be provided in the Waldur custom script:

  • WALDUR_API_URL - API URL of Waldur that holds OpenStack
  • WALDUR_API_TOKEN - Waldur API token
  • KEYCLOAK_URL - Keycloak address for creating OpenID connect clients
  • KEYCLOAK_USERNAME - Keycloak admin username
  • KEYCLOAK_PASSWORD - Keycloak admin password
  • KEYCLOAK_REALM - Keycloak realm
  • CREATOR_EMAIL - Email of the user, that created the VPN instance
  • IMAGE - OpenStack image
  • FLAVOR - OpenStack flavor
  • SYSTEM_VOLUME_SIZE - Size of the system volume for OpenStack VM
  • RUN_BUTANE_IN_DOCKER - When set to True - run butane in docker container instead of just binary

Waldur Guacamole integration

Guacamole is a browser based remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH. Waldur — Guacamole integration is based on Waldur's custom scripts functionality.

This integration provides full virtual desktop lifecycle, including:

  • Creation of a virtual desktop in remote Waldur (i.e. OpenStack KVM machine)
  • Adding records of a freshly created virtual desktop to Guacamole MySQL database
  • Termination of the virtual desktop and MySQL records removal upon desktop deletion

Quick Start Guide

  • Make sure your Waldur is able to run custom scripts
  • Modify Guacamole MySQL database to store backend ID (Backend Waldur resource ID):
1
ALTER TABLE guacamole_connection ADD backend_id VARCHAR(50);
  • Create a Service Offerring in Waldur with "Custom Script" type
  • Configure environment variables for the service:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Guacamole MySQL connection settings
MYSQL_USER=guacamole
MYSQL_DATABASE=guacamole
MYSQL_PASSWORD=password
MYSQL_HOSTNAME=guacamole.example.com
# RDP Password for the desktop user
DESKTOP_PASSWORD=password
# Backend Waldur connection settings
BACKEND_WALDUR_URL=https://waldur.example.com/api/
BACKEND_WALDUR_TOKEN=api_token
BACKEND_WALDUR_OFFERING=offerring_uuid
BACKEND_WALDUR_PROJECT=project_uuid
BACKEND_WALDUR_IMAGE=image_name
BACKEND_WALDUR_FLAVOR=flavor_name
BACKEND_WALDUR_SUBNET=subnet_uuid
BACKEND_WALDUR_SECURITY_GROUP=security_group_name
  • Copy custom-scripts/create.py and custom-scripts/terminate.py as the creation and termination scripts for the service

Ended: Existing integrations

Ended: Integrator guide

User guide ↵

User guide

This section contains instructions to typical operations done with Waldur. The section can be used as a basis for deployment-specific documentation.

Practical guides for the customer organization

Practical guides for the service provider organization

Practical guides for the call managing organization

Practical guides for the end users

Practical guides for the staff and support users (deployment administrators)

Call Management

Overview

Call management in Waldur enables organizations to manage resource allocation through a structured application proposals and review process. This feature is particularly useful for research institutions, funding agencies, and organizations that need to allocate computational or infrastructure resources through a competitive process.

Introduction

Call management in Waldur is built around structured components: calls, rounds, proposals, and reviews. A call is a defined period during which resources can be allocated. Each call is divided into rounds, where stakeholders can submit and review proposals for resource allocation. Proposals are evaluated through a structured review process. Successful proposals lead to approved allocations, seamlessly integrating into the rest of the Waldur ecosystem. When a proposal is approved, Waldur automatically creates a project under the proposing organization that initiated the call. Allocations are granted to this project, and team members who submitted the proposal are added to the project, ensuring the resources are immediately ready for use.

Prerequisites

  • Organization must be registered as a Call Managing Organization
  • Marketplace offerings must be available to be requested in calls

Stakeholder Roles

Organization Owner

  • Assign call managers
  • Grant final resource allocations, if defined in round configuration
  • View statistics across all calls in the organization
  • Archive calls when they are no longer active

Call Manager

  • Create and configure calls
  • Manage call rounds
  • Set review strategies
  • Assign reviewers
  • Make decisions (if configured as deciding entity)
  • Add documentation and descriptions
  • Monitor call progress
  • Close rounds early if needed
  • Manage requested offerings from service providers

Call Member (Applicant)

  • Submit proposals to active rounds
  • Upload required documentation
  • Select offerings and allocations
  • Add team members to proposals
  • Track proposal status
  • Provide additional information during revision process
  • View review feedback when available

Reviewer

  • Evaluate assigned proposals
  • Provide scores and feedback
  • Complete reviews within specified duration
  • Accept or reject review assignments
  • Provide both public comments (visible to applicants) and private comments (visible only to call managers)

Service Provider

  • Accept or reject requests to include their offerings in calls
  • View requested resources related to their offerings
  • Configure parameters for offerings available in calls

Call Structure and Workflow

1. Call Setup

  1. Organization owner assigns call managers
  2. Call manager or Organization owner creates a call
  3. Call manager configures call rounds
  4. Call manager requests offerings from service providers
  5. Service providers accept or reject offering requests
  6. Call manager activates the call when configuration is complete

2. Round Configuration

Call manager must configure:

  • Start and end dates
  • Review strategy options:
  • After round closure
  • After proposal submission
  • Review parameters:
  • Review duration (in days)
  • Minimum number of reviewers
  • Minimal average scoring threshold for automatic approval (if applicable)
  • Decision making:
  • Deciding entity (call manager or automatic)
  • Allocation timing (on decision or fixed date)
  • Allocation date (if fixed date is selected)
  • Round description and documentation
  • Reviewers and managers assignment
  • Default project role for proposal team members

3. Proposal Submission

Call members should:

  • Submit proposals to active rounds
  • Upload required documents
  • Select offerings and allocations
  • Add team members (optional)
  • Provide required details:
  • Project name
  • Project summary
  • Description
  • OECD FOS 2007 code (Fields of Science classification)
  • Civilian purpose declaration
  • Confidentiality requirements
  • Duration in days

4. Review Process

  1. Reviewers are assigned to rounds
  2. Reviewers are assigned to specific proposals
  3. Reviews are conducted according to strategy
  4. Feedback and scores are provided on multiple aspects:
  5. Project title
  6. Project summary
  7. Project description
  8. Project duration
  9. Supporting documentation
  10. Resource requests
  11. Team composition
  12. Summary score and comments are provided
  13. Reviews are submitted for consideration

5. Decision and Allocation

  1. Decision maker (as configured) evaluates reviews
  2. Final decisions are made (allocation or rejection)
  3. For allocated proposals:
  4. A project is automatically created
  5. Requested resources are provisioned in the marketplace
  6. Team members are assigned the configured project role
  7. Resource limits are applied as specified in the proposal

6. Tracking and Reporting

  1. Call managers can monitor statistics on:
  2. Open calls
  3. Active rounds
  4. Accepted proposals
  5. Pending proposals
  6. Pending reviews
  7. Rounds closing soon
  8. Pending offering requests
  9. Organization owners can track resource allocation across all calls

States and Transitions

Call States

  • Draft: Initial state, call is being configured
  • Active: Call is open for submissions
  • Archived: Call is completed and no longer active

Round Statuses

  • Scheduled: Round start date is in the future
  • Open: Round is currently accepting submissions
  • Ended: Round cutoff date has passed

Proposal States

  • Draft: Initial creation, editable by applicant
  • Submitted: Sent for review, awaiting reviewer assignment
  • In Review: Assigned to reviewers, under evaluation
  • In Revision: Sent back to applicant for changes
  • Accepted: Approved for resource allocation
  • Rejected: Declined for resource allocation
  • Canceled: Withdrawn or automatically canceled

Review States

  • Created: Review has been assigned
  • In Review: Reviewer has accepted and is working on evaluation
  • Submitted: Review is complete
  • Rejected: Reviewer has declined the assignment

Requested Offering States

  • Requested: Initial state, awaiting service provider decision
  • Accepted: Service provider has approved use in call
  • Canceled: Service provider has declined use in call

API Endpoints

The system provides RESTful API endpoints for:

  • Managing Call Organizations
  • Creating and configuring Calls
  • Managing Rounds
  • Submitting and updating Proposals
  • Assigning and completing Reviews
  • Requesting and approving Offerings
  • Allocating resources

Best Practices

  • Set clear evaluation criteria and communicate them to applicants
  • Provide comprehensive round documentation including resource availability
  • Allow adequate time for review process (recommended: 2+ weeks for reviews)
  • Configure appropriate minimum number of reviewers (recommended: 2-3)
  • Maintain consistent communication with applicants throughout the process
  • Close rounds promptly when cutoff dates are reached
  • Monitor reviewer workload to ensure balanced distribution
  • Configure automatic allocation only when clear scoring criteria are established
  • Provide templates for proposal documentation where applicable
  • Schedule multiple rounds in advance for recurring allocation cycles

Troubleshooting

Round Configuration

  • Issue: Round dates overlap with existing rounds Solution: Adjust dates to ensure no overlap within the same call

  • Issue: Unable to create a round Solution: Ensure call is in Draft or Active state

Proposal Submission

  • Issue: Unable to submit proposal Solution: Verify round is in Open status and required fields are completed

  • Issue: Resource requests unavailable Solution: Check that service providers have accepted offering requests

Review Assignment

  • Issue: Not enough reviewers available Solution: Assign additional reviewers to the call or adjust minimum number requirement

  • Issue: Reviews not being created Solution: Verify review strategy configuration and check reviewer availability

Allocation Process

  • Issue: Resources not provisioned after approval Solution: Check marketplace availability and quotas

  • Issue: Team members not added to project Solution: Verify default project role configuration

  • Issue: Unable to allocate proposal Solution: Ensure proposal is in correct state (In Review, Submitted) and review requirements are met

Ended: Call managing organization

Cost and usage policies

Waldur allows to set different cost and usage policies on organization, project and offering level. For example, this means that organization owners and service providers can enable different actions, when cost or usage exceedes predefines level.

Cost policies for organizations

Staff role can define cost policies for organizations. To add a new policy, open Administrations menu from the left and then Organizations -> Cost policies from the top. This view provides an overview about already defined policies. To create a new one, select "Add" from the right. Cost policy for organization

From the popup, select organization, then set estimated cost limit and finally choose the action (what happens, when the limit is reached). New organization cost policy

Cost policies for projects

Organization owners can set different cost policies for projects under particular organization. To add a new policy, open Organizations menu from the left and then Accounting -> Cost policies from the top. This view provides an overview about already defined policies. To create a new one, select "Add" from the right. Cost policy for project

From the popup, select project, then set estimated cost limit and finally choose the action (what happens, when the limit is reached). New project cost policy

Cost policies for offerings

Offering managers can set cost policies for specific organization groups. This allows to trigger some actions, when cost is reached. To add new policy, offering manager should open offering management page (Organization from the left menu, then Service provider -> Marketplace -> Offering) and then Policy -> Cost policy from the top. This view provides an overview about already defined policies. To create a new one, select "Add" from the right. Cost policy for offering

From the popup, set estimated cost limit, choose the action what happens after cost is reached (block creation of new resources or notifying the organization owners). Then, it is needed to select period (is this policy per month, quarter, annual or total) and finally select organization group for which this policy applies to. New offering cost policy

Usage policies for offerings

Offering manager can set different usage policies for specific organization groups. This allows to trigger some actions, when usage of defined resource component is reached. To add new policy, offering manager should open offering management page (Organization from the left menu, then Service provider -> Marketplace -> Offering) and then Policy -> Usage policy from the top. This view provides an overview about already defined policies. To create a new one, select "Add" from the right. Offering usage policy

From the popup, select accounting component and set limit for that. Several compoments can be defined in one policy. Then, it is needed to select period (is this policy per month, quarter, annual or total) and finally select organization group for which this policy applies to. New offering usage policy

Credit management for organization owners

Credit management establishes credit limits for organizations that can be used for purchasing eligible services. The credit can optional be sub-allocated to projects and used in cost policies.

If credits are assigned to organizations by staff users (please see Credit management for staff), organization owners can distribute allocated credits to projects. Projects can use credits for specific resources, overused resources are invoiced according to the pricing plan. Organization owners can use credit management together with the cost and usage policies to handle overconsumption.

To see current credit management policies, open the organization dashboard and then Accounting -> Credit management from the top menu.

Customer credit policies

To create a new one, click "Add" on the right. A popup opens with configuration fields:

  1. Project - select the project, which can use the credits.
  2. Allocate credit - set the maximum amount of credits.
  3. Use organization credit after exceeding allocated amount - Enable, if project can use organization credits after running out of project credits. If disabled, resource usage will be invoiced according to the pricing plan.
  4. If all set, click "Create".

New project credit policy

Organization membership management

Organization team contains users with different roles.

Please see this page for User Rights based on Roles in the Organization.

Adding organization members

  1. Open your organization in Waldur.
  2. Select "Team" from the menu and click on "Invitations".

  3. By clicking "Add" open "Invite by email" window.

    Select organization

  4. Insert user's email and set the role for the new user and continue.

    Select organization

  5. Fill in your custom message on the right side of the window and send the invitation.

  6. User now will get invitation email with the acceptance link.

Project management

Project creation is allowed for organization owners in their organizations and staff users.

Note

User must have an account in Waldur instance to create projects.

  1. Select your home organization.
  2. Under the Project tab, click on Add.

  3. Fill the necessary fields (fields marked with * are mandatory) and click Create.

    • Project name - The original title of the project.
    • Project description - A brief description about the project.
    • OECD FoS code - OECD science field code (more info)
    • Start date - once reached, marks the date when prepared user invitations are sent out and triggers the processing of previously made resource orders.
    • End date – once reached, triggers the creation of termination orders for the existing resources. If the resources have already been terminated by this time, the project will be removed. The date is inclusive.

  4. If you need to edit project details later, open your project and select the Edit tab.

Note

  1. If a resource has a termination date that comes after the project's end date, the project's end date will automatically become that resource's termination date.
  2. If a resource has a termination date that comes before the project's end date, we'll use the resource's original termination date.
  3. Important: Setting any end date (either the project's or a resource's) only creates a termination request. The resource remains active in the project until the termination process is fully completed.

Project membership management

Project team contains users with different roles.

Please see this page for User Rights based on Roles in the Project.

Adding project members

New user already has account in current Waldur instance

  1. Open your project in Waldur.
  2. Select "Team" from top menu and click on "Users".

  3. By clicking "Add member" open "Add project member" window.

    Select organization

  4. Select correct user, set the role and expiration date if necessary.

    Select organization

  5. Finally, click on "Add".

  6. User now will get invitation email with the acceptance link.

New user don't have a account in current Waldur instance

  1. Open project in Waldur.
  2. Select "Team" from top menu and click on "Invitations".
  3. By clicking "Invite user" open "Invite by email" window.
  4. Insert user's email and set the role for the new user and continue.
  5. Fill in your custom message on the right side of the window and send the invitation.
  6. User now will get invitation email with the acceptance link.

Resource management

VPC management

Info

There are several Virtual Private Cloud providers available on the ´Marketplace´. You need to provision at least one VPC package from a suitable provider in order to be able to create virtual machines.

  • Virtual Private Cloud (VPC) resource package can be added by clicking to ´Marketplace´ and selecting ´Private Clouds´ from the menu to go to the list of VPC.

VPC selection

  • Currently, there are three VPC component names listed: ´Cores´, ´Ram´, and ´Storage´. For configuration of a VPC resource please fill in a suitable quantity for each component and click on the ´Add to cart´ button. Here by changing the quantities of components, you can see Prices accordingly per day, per 30 days, per 365 days, and finally the total price of the VPC.

VPC addition

  • It is mandatory to input ´Tenant name´ to order a VPC.
  • We also strongly suggest filling the ´Tenant description´ field.

VPC addition

  • Finally click on Add to cart and Request on the next page.

VPC add to cart

VPC request

Request approval

a) If your role in the Project is ´Project Manager´ or ´System Administrator´, please ask your Organization Owner to approve the order.

b) If your role is ´Organization Owner´ you are able to complete the purchase to final approval (click the ´Purchase´ button). Hereafter the system will need a couple of minutes to execute the order. Once the system changes the state to ´Done´, your VPC is ready to use.

VPC executing

VPC done

Info

Provisioned VPC resource package will be automatically enabled for the project as a VM provider. For other projects it can be enabled by the organization owner under Provider management within organization workspace.

VM management

Info

Projects need to have at least one VPC resource package enabled before any virtual machines can be created. You can follow this guide to add a new VPC.

  • VMs can be added by clicking to ’Marketplace’ and selecting ’Virtual machines’ from the menu to go to the list of Virtual Machines.

VM marketplace

  • Ordering a ’Virtual Machine’ requires a VM name and selection of a VM image.
  • Please select the ’Image’ for a VM and click on the ’Select’ button, returning to the form.

VM addition 1

  • Selecting the initial VM resource profile, the flavor, by clicking on the ’Flavor: Show choices’ selector is mandatory.
  • The flavor will set the initial resource profile for a VM - how much RAM, vCPU cores, and storage it will have.

Warning

VM images contain their minimum requirements information, and non-matching VM flavors are disabled automatically.

  • Selecting VM flavor will also update ’System volume size’ with the option to override it manually (to a higher custom value). The size of ’Data Volume’ can be customized and incremented in 1 GB steps. ’System volume’ must be at least 10 GB, whereas ’System volume’ and ’Data volume’ must be equal to or less than VPC’s total Storage.

VM addition 2

  • By default, provisioned virtual machines expect users to log in using SSH keys. The initial SSH key for login should be selected by clicking on the ’SSH public key: Show choices’ selector.

Warning

There has to be at least one SSH public key added to the user profile for it to appear in the SSH key selector list.

Info

In order to log in to your newly created VM over SSH, you need to use a username depending on your choice of VM Image type and your SSH-RSA key-pair. By default password authentication is disabled.

  • Default usernames for login are as follows:
  • CentOS images: CentOS
  • Ubuntu images: Ubuntu
  • Debian images: Debian
  • FreeBSD images: FreeBSD
  • By default, no incoming connections will be allowed for a VM. Predefined Security Groups (firewall rules) must be linked to a VM in order to open up access (like ssh, HTTP, etc.). By clicking the ’Details’ button, you can see the details about the available ’Security Groups’. ’Security Groups’ can be added while ordering the VM or afterward by editing.

Info

VM create form will automatically include a ’default’ security group that enables egress (outgoing) traffic for a VM and which is required in order to reply to any of the incoming packets.

  • VM needs to be connected to at least one of the VPC (internal) networks and an external network via floating IP - if external/public access to VM is required.

Info

Floating IP is technically realized as 1:1 NAT between VM internal IP and public network IP.

VM addition 3

VM addition 4

  • We strongly suggest also adding ’VM description’. In order to provision the VM, please click on the “Add to cart” button.

VM request

Info

On the right pane, there will be a ’Checkout summary’ with the purchase overview and indicative VM cost (as part of the VPC package cost).

  • VM should reach into “Active” status when successfully provisioned. The “Access” field will show the IP address to access VM over SSH (Linux) or over RDP (Windows).

VM ready

Info

VM access over SSH or RDP should be permitted by ’Security Groups’ linked to VM.

HPC resource management

  • HPC resources can be added by clicking to ´Marketplace´.
  • Select organization and project (if not filled in yet) from the upper right corner.
  • selecting ´HPC´ category or some other option which represent HPC resources.
  • Select desired resource and click 'Deploy'.
  • Fill in request form fields and click 'Create' on the right.

Resource components update

If it turns out that initial limits for the resource are too low or higher than expected, then it is possible to change the limits after the resource creation. This can be done by opening the resource management section. Again, like in the resource creation phase, same approval flow applies.

Usage reports

Usage of a resources

To see overall usage information of resources, please select "Reporting" from the left-side menu and then "Usage reports" on the top menu.

It is possible to filter te results by organization, project, offering and export results.

Usage reports

To view the usage information within a project:

Private clouds

To view the usage information within a project:

  1. Open your project in Waldur.

  2. Select the private cloud resource that usage report you would like to see.

  3. Now private cloud resource dashboard provides the overview of limits and used quotas. Private cloud) usage

HPC

  1. Open your project in Waldur.

  2. Select the allocation (resource) that usage report you would like to see.

  3. On this window, Select "Usage" to see the usage of a resource. Use tabs "CPU Allocation", "GPU Allocation", and "Storage Allocation" to see the details. Resource usage

  4. By default, the view shows last 6 months information. To see the usage from the creation of a resource, please use period selector on the right side. Period selection

  5. Instead of graph view, it is possible to switch to table view as well. To do that, please use switching button on the right next to the period selector. Table view

  6. It is possible to download the graph views as PNG images. To do that, please use the arrow icon on the right side of the graph. PNG download

To check the current resource allocation limit:

  1. On the same window, the plan details for Allocation components (CPU, GPU, and storage) can be found on the top-right side. Resource limits

Ended: Customer organization

Interface Introduction

Basics

Dashboard

  • It is the first page you see (by default) after logging in to Waldur, which provides you with the initial necessary information of your profile, the Organizations and the Projects.

Organization / Project selection

  • You can see the information about the organization only If you are at the organization level. It means if you are only at the project level, you can not go to the organization level.

Sidebar menu

  • This is your main working tool in Waldur. Here you can manage your organizations, projects and resources. The next chapter of this guide will provide the details for each menu item.

Workspace menu (changes depending on sidebar menu)

  • Each page in Waldur has a navigation bar at the top of the screen. It enables a quick access to organization/project info and management.

Workspace

  • Shows organization, project or user dashboards related to the selection.
  • Contains all necessary action fields a user might need.

Issues

  • Displays the list of user related issues. Here by Creating request you can request support.

Favorite Pages

  • The opportunity to gather the most visited pages to make them easily reachable.

Pending confirmations

  • Contains the list of requests related to user, resources or project management.

User Profile

  • The main links related to the user actions like User Dashboard, Affiliations, Credentials, Notifications, Language and Color mode of the interface.

Get help

  • By clicking Support you can find User Documentation, or reach us by using support email address and also create support request by going to "Issues" window.

Ended: End users

Accounting

Accounting of Service providers

Service provider revenue

If the organization is service provider, then it is possible to check the amount of revenue of a running month. To do that, open the organization dashboard, choose "Service provider" view and then dashboard opens. There you will see the total amount of estimated revenue and also 11 previous months.

By clicking on "Active clients" on the left, it's possible to see more detailed information about clients and amounts. Service provider revenue

Invoices

Waldur provides a convenient way to see the invoices issued to the organization. Open the organization dashboard and select “Accounting” from the top menu and then “Invoices”. Now you’re able to see all invoices issued to the organization. Invoices

Invoices’ information can be downloaded in different formats as well. Invoice export

Estimated cost

Estimated cost of a running month can be seen from the same view as invoices. By default, it shows top 4 projects with the highest cost. By clicking “Details”, you are able to see all projects with estimated costs. Estimated cost

Offerings

To create a new Offering in the Marketplace, you need to:

  • Assure that categories are configured in the Marketplace.
  • Create at least one service provider.
  • Create and activate a public offering.

Waldur supports a number of different types of service providers when creating a shared offering. A common way of creating an offering is through a HomePort.

OpenStack offering creation

  1. Select organization, which will provide the offering.

  2. Go to Provider dashboard, click Marketplace -> Offerings from the top menu and then Add from the left. Adding an offering

  3. A popup opens, fill in the name for the offering, category (e.g. Private clouds) and type (OpenStack tenant) and click Create. Adding details

  4. An offering configuration page opens with an option to edit different attributes.

    Adding details

  5. For the OpenStack integration, select Integration -> Credentials from the top menu. Fill in requested parameters.

    • API URL - OpenStack deployment keystone URL
    • Domain name - OpenStack domain name
    • Username - Tenant user username
    • Password - Tenant user password
    • Tenant name - OpenStack tenant name
    • External network ID - OpenStack extnet UUID

    Adding details

  6. If everything is filled in, click on Synchronize in the top left corner. After few seconds, the State field will show OK if the integration is completed between Waldur and OpenStack.

  7. To adjust the accounting, select Accounting from the top menu and then Plans -> Edit prices. Default accounting components are already defined.

    Adding details

  8. If everything is completed and ready, click on Activate in the upper right corner to publish the offering.

SLURM offering creation

  1. Select organization, which will provide the offering.

  2. Go to Provider dashboard and click on Marketplace -> Offerings from the top menu and then click Add from the right. Adding an offering

  3. A popup opens, fill in the name for the offering, category and type. Adding details

  4. An offering configuration page opens with an option to edit different attributes. Offering details

  5. Under Endpoints section, you can add access endpoints for the offering, for example, management consoles, SSH login nodes or similar. Offering endpoints

    This configuration will display then to resource of the offering a menu for easier navigation to the corresponding services. For SSH protocol this would trigger opening of an SSH client if configured for the browser. Out of the box works on OS X and Linux, requires configuration of the default application on Windows. Resource endpoints

  6. To add accounting components, select "Accounting components" from the top menu and then "Add component" from the right side. Accounting component is a measurable unit of a resource. For example, it can be CPU hours, GPU hours, storage hours, RAM etc. Accounting components

  7. A popup opens with possibility to configure fields and select the accounting type (whether the component is billed by the usage, max limit or it has a fixed price).

    • Usage-based - billing is applied according to the actual usage of the resource during the billing period defined in the accounting plan after the submission of a usage report;
    • Limit-based - billing is applied according to the requested/updated limits of a resource, actual usage can be below the limits and it is not the basis of the billing;
    • Fixed price - billing is applied according to the exact values defined by the service provider in the accounting plan, limits and usage are not the basis for the accounting;
    • One-time - billing is applied once on resource activation;
    • One-time on plan switch - billing is applied once on resource activation and everytime a plan has changed, using pricing of a new plan.

    Accounting component details

  8. To configure accounting frequency and prices, select "Accounting plans" from the top menu and then "Add plan" from the right. Select a name for the plan and accounting frequency. Accounting frequency

  9. To define prices for the components, select "Actions" and then "Edit prices". Set new price and save. If there is a need to provide higher priority access to resources with different prices, then it is advised to create another offering for this kind of cases. Offering prices

    Offering prices

  10. If all set, click "Activate" on the top-right side to make it visible to everybody. Activate offering

Tip

For more advanced cases of management of offerings, take a look at how a SLURM offering can be managed using Ansible module.

Offering management

It is possible to temporarily unpublish the offering. For example, if the service is down for a longer maintenance. To do that, open the offering edit page and click on Pause from the right.

Offering pause

If the offering is not needed anymore, then it is possible to archive it by selecting Archive from the offering edit page.

Offering archive

Configuring Getting Started Templates

When setting up an offering, you can configure a "Getting Started" guide that will be shown to users after they provision a resource. This guide supports dynamic variables that are automatically replaced with actual resource values.

Available Template Variables

  • {resource_name} - The name of the resource
  • {resource_username} - The username associated with the resource
  • {backend_id} - The backend identifier (e.g., SLURM account name)
  • {backend_metadata_key} - Any metadata fields from the backend (e.g., {backend_metadata_state})
  • {options_key} - Any custom options set for the resource (e.g., {options_custom_field})

Example Template

For SLURM allocations, you might want to create a comprehensive guide like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Getting Started with your SLURM Allocation

Welcome to your new SLURM allocation. Here are your access details:

- Account name: {backend_id}
- Username: {resource_username}
- Resource name: {resource_name}

## Status

Current state: {backend_metadata_state}

To configure this template:

  1. Go to your offering's page
  2. Select "Edit" from the top menu
  3. Scroll down and find the "Getting started instructions" and click the "Edit" button
  4. Enter your desired template information using the variables above
  5. Save the changes

The template will be rendered with retreived values when users access their resources.

Service offering configuration guide

Overview

This guide provides a structured approach for integrators to define an Offering. Offerings represent services, resources, or products made available through the platform.

General information

The General Information section defines the core attributes of an offering, including its identity, accessibility, and governance policies.

Required fields

  • Name – The title of the offering, displayed across the platform
  • Description – A concise summary outlining the offering's purpose
  • Full description – A detailed explanation, including technical aspects and potential use cases
  • Terms of service – Any contractual obligations or usage restrictions
  • Privacy policy link – URL linking to the privacy policy
  • Terms of service link – URL linking to the terms of service
  • Access URL – The main entry point for users to access the offering
  • Slug – A unique identifier used in URLs (readonly)
  • Location – The geographical or virtual location of the offering
  • Access policies – Defines access control rules and user eligibility
  • Logo – A graphical representation of the offering
  • Getting started instructions – Guidelines on how users can begin using the offering

Public information

The Public Information section ensures visibility and accessibility for end users. It includes Endpoints, Categories, and Images.

Endpoints

Endpoints provide connectivity to the offering's services. Each endpoint requires:

  • Name – A human-readable identifier for the endpoint
  • URL – The direct link to access the service

Images

Images provide visual representation and marketing appeal. Each image requires:

  • Name – A descriptive title
  • Description – A brief explanation of the image content
  • Attached image file – The image file itself

Service provider registration

In Waldur, only organizations registered as service providers can create offerings and provide the service to users.

To register organization as service provider:

  1. Open organization dashboard, click on "Edit" and select "Service provider" from the top menu. Service provider registration

  2. Click on "Register as service provider" on the right. Service provider registration

  3. Add service provider organization description. This description is visible in the Waldur marketplace under service provider list and under provider details. Service provider description

  4. Make sure that service provider organization category group is also set.

Ended: Service provider organization

Announcements

The Waldur User Interface provides an easy way to inform users about important updates and changes through announcements.

Currently, there are three types of announcements:

  • Information – Provides general updates, new features, or helpful tips.
  • Warning – Alerts users about potential issues or changes that may affect their experience.
  • Danger – Signals critical issues, errors, or risks that require immediate action.

Announcement management

  1. Navigate to Administration → Settings → Announcements.

List of announcements

Adding an announcement

  1. Select Add from the announcement management page.
  2. Choose the type of announcement, as well as the start and end times.
  3. Enter the message for the users.
  4. Click Create.

List of announcements

Editing an announcement

If you need to edit existing announcement, then:

  1. Navigate to announcement management page.
  2. Find the announcement you would like to change.
  3. Under the Actions column on the left side of the announcement, click the Edit button (visible by clicking on the three dots).

Once an announcement is active, it will be displayed to users on every page, just below the Search box.

List of announcements

Branding configuration

The portal allows you to customize its appearance to match your organization's brand identity. This guide will help you configure the branding settings.

Accessing Branding Settings

  1. Navigate to the Administration section in the left-side menu
  2. Click on Settings
  3. Select the Branding tab

Branding

Available Customization Options

Branding

  • Site Name: Sets the name of the organization.
  • Page title: It is used as page title.
  • Site description: Description of the Waldur deployment.

In the same page you will find more sections to customise

  • Marketplace branding
  • Notifications
  • Links
  • Theme
  • Images

Note

All changes in branding settings will be applied system-wide. Please preview changes before saving to ensure they meet your organization's visual guidelines.

Broadcast

The broadcast functionality allows you to send messages to specific groups of users within Waldur. You can target messages to the following:

  • Offering users
  • Organization members
  • All users connected to your Waldur deployment

Management of broadcast messages

To manage broadcast messages, follow these steps:

  • Select Support from the left-side menu.
  • Click Broadcast in the top menu.

The Broadcast Management page shows both sent messages and drafts. From here, you can view message history and create new broadcasts.

Broadcast templates

You can create broadcast message templates, which is useful for sending certain types of messages frequently (e.g., maintenance announcements).

To create a new template:

  • Navigate to Support → Broadcast templates.
  • Click Add.

A popup will appear with the following fields:

  • Name: Name of the template
  • Subject: Subject line for the broadcast message
  • Message: Content of the message

New broadcast template

Creating new broadcast message

To create a new broadcast message:

  • Navigate to Support → Broadcast.
  • Click Add.

A popup will appear with the following fields:

  • Template: Select a predefined template (optional)
  • Subject: Subject line for the broadcast message
  • Message: Content of the message
  • Send at: Schedule a send time for the message, or leave blank to send immediately

You can then either save the message as a draft for later editing or save it as a template for future use.

If everything looks good and you would like to send it out, click Select recipients.

New broadcast

Selecting Recipients

In this step, you can define the target users for the broadcast message:

  • Specific offering(s) users
  • Specific organization(s) members
  • All users connected to your Waldur deployment

Once you're ready, click Send broadcast.

New broadcast

Catalogue mode

This guide explains how to enable and use the Catalogue mode in Waldur. This feature changes the marketplace to a catalog-only view, where services are displayed as a list of offerings but cannot be ordered directly through the platform.

Enabling Catalogue mode

Step 1: Access Administration settings

Navigate to the Administration section in Waldur.

Administration Navigation

Step 2: Configure features

  1. Select Settings from the menu
  2. Locate the Features selection
  3. Find the "Marketplace offerings and resources" section
  4. Look for "Allow marketplace to function as a catalogue only"
  5. Toggle the switch to enable the feature

Catalogue Mode Setting

Understanding Catalogue mode

When enabled, Catalogue mode introduces the following changes:

Key features

  • Display-Only Functionality: The marketplace transforms into a directory-style listing of services
  • No Direct Ordering: Offerings cannot be ordered directly through the portal
  • Service Showcase: Organizations can present their services and offerings in a "yellow pages" format

Use cases

  • Organizations wanting to showcase their services without enabling direct ordering
  • Creating a comprehensive service directory
  • Establishing a reference point for available offerings across different organizations

What changes?

  • Order buttons are removed from offering details
  • Focus shifts to informational display of services
  • Maintains full visibility of offering details and specifications
  • Preserves organization and category browsing capabilities

Note

The Catalogue mode can be disabled at any time by following the same steps and toggling the feature off.

Changing user passwords

This guide explains how administrators can change user passwords in Waldur.

Important note

⚠️ This guide only applies to local Waldur accounts:

  • For users authenticated via LDAP: Manage passwords in your LDAP directory
  • For users authenticated via OIDC: Manage passwords in your OpenID provider
  • For users authenticated via SAML: Manage passwords in your SAML identity provider

Prerequisites

  • Staff account access

Steps to change user password

  1. Access the admin panel
  2. Navigate to <your-waldur-instance>/admin/

  3. Log in with your staff account credentials

  4. Locate user settings

  5. Go to "Users" section

  6. Select "Users" from the list

  7. Find specific user

  8. Use the search function to find the user

  9. Click on the username to access their details

  10. Change password

  11. Locate the password field
  12. Enter and confirm the new password
  13. Save changes

Important notes

⚠️ Security warnings:

  • Only use this feature when absolutely necessary
  • Ensure password changes comply with your organization's security policies
  • Notify users when their passwords have been changed
  • Document password changes according to your security protocols

Credit management configuration for staff

Credit management establishes credit limits for organizations that can be used for purchasing eligible services. The credit can optional be sub-allocated to projects and used in cost policies.

Users with staff role can allocate credit points to organizations. This can be done by selecting Administration from the left side menu and then Organizations -> Credit management from the top menu.

Credit management policies

This page provides an overview of already assigned credit policies. To create a new one, click on "Add" from the right. A popup opens with different configuration fields.

Credit management new policy

  1. Select an organization to which you would like to assign credits.
  2. Select an offering for which credits can be used.
  3. Set the credit value. This is the total value that the organization will be able to spent.

  4. Minimal consumption logic defines, how minimal monthly consumption is calculated:

    • Fixed means that it is possible to define minimal monthly value and overall credit will be reduced by the monthly value, even if the usage has been less than minimal consumption.
    • Linear means that by setting the end date, the total value of the credit will be divided evenly across the period until the end date and the overall value will be reduced monthly by the calculated value even if the consumption is less than the calculated value.

  5. If all set, click "Create".

Impersonation functionality

Waldur provides Impersonation functionality to allow the support team to debug and resolve user-related issues more efficiently. This feature enables support users to view the user interface (UI) as though they were the user they are impersonating.

Prerequisites

  1. The impersonator must have a staff role in the Waldur deployment.
  2. The user being impersonated must have an active session (users cannot be logged out).

Process guide

  1. Log in to the Waldur deployment using a staff account.

  2. Navigate to the Administration menu, then go to Accounts → Users from the top menu.

    Impersionation

  3. Locate the user you wish to impersonate and select Impersonate from the Actions options.

    Impersionation

Logging

All actions performed on behalf of a user are logged with additional context in the audit logs, including the impersonator's UUID, full name, and username. This is primarily for security purposes.

Organization management

Overview

In Waldur, an organization represents a configurable grouping unit that can be adapted to various contexts such as research groups, institutions, departments, or working groups. Each organization has an designated owner who manages the organization's projects, users, and associated resources.

Create a new organization

Note

Organization creation is only allowed for users in Staff role!

  1. Login to Waldur and select "Organizations" from the left-side menu and then select "Add" from the right.

  2. Fill the form and click "Create organization":

    • Name - Name of the organization
    • Contact email - email of the person, who is responsible for the organization

  3. Organization edit page opens, where it is possible to add additional information, like policies, contact information. It is beneficial to assign a predefined category group (like private company, university, government, individial person etc) to organization.

Note

After the creation of the organization by the staff user, organization owners can manage organization details. To do this, navigate to the organization dashboard and select Edit.

Organization configuration

The organization edit interface consists of six main tabs, each containing specific configuration options:

Basic details

  • Name - Full organization name
  • Abbreviation - Short form of organization name
  • Address - Physical location
  • Postal code - Postal/ZIP code
  • Country - Country of registration
  • Organization groups - Associated group categories
  • Location - Geographic location

Identifiers

  • UUID - System-generated unique identifier (non-editable)
  • Slug - URL-friendly identifier (non-editable)
  • Registration code - Official registration number
  • Agreement number - Contract reference number
  • Sponsor number - Sponsorship identifier

type:image

Contact information

  • Email - Primary contact email
  • Phone number - Contact telephone
  • Contact details - Additional contact information
  • Homepage - Organization's website

type:image

Access control

To configure network access restrictions add access subnets by specifying:

  • CIDR - Network address range
  • Description - Purpose or identifier for the subnet

type:image type:image

Billing

Contains billing-related configurations:

  • Billing details
  • Tax information

type:image

Call manager

You can enable Call manager by enabling the radio button:

  • Enable call manager

type:image

Service provider

You can register organization as a service provider by pressing the button:

  • Register as service provider

type:image

Remove

Provides organization removal functionality:

  • Click "Remove organization" button to delete the organization

type:image

Note

Organization removal should be handled with caution as it may affect associated projects and users. Ensure all necessary data is backed up before proceeding with organization removal.

Multiple projects removal via admin panel

An admin can remove projects with all related resources with the following sequence of actions:

  1. Go to admin panel (e.g. http://localhost:8080/admin/)
  2. Open list of projects: Structure tab -> Projects
  3. Filter the projects by organization field (optional)
  4. Select projects for removal
  5. Set action field to Delete projects with all resources

Project removal

Remote sync of offerings

Remote sync functionality allows you to import offering information from another Waldur instance and periodically update it.

Prerequisites

  1. The remote Waldur instance must have at least one organization with at least one offering.
  2. An integration user must be created under the organization in the remote Waldur instance. Its token is needed in the creation step.
  3. Category mapping analysis must be completed. This involves mapping the remote offering categories to the local ones.

Remote offering sync management

To manage existing offering syncs, follow this process:

  1. Log in to the local Waldur instance, open the Administration menu, and select Marketplace -> Remote Offering Sync from the top menu.

  2. The Remote Offering Sync Management page opens.

    Remote sync management

  3. From this page, you can create a new sync, edit an existing one, or delete a sync.

    • Enable/Disable: Temporarily enable or disable the sync for a particular remote instance.
    • Synchronize: Perform a one-time manual sync.
    • Show Results of Last Run: View what was imported during the last sync.
    • Edit: Modify the configuration of a particular sync.
    • Delete: Remove a remote instance sync.

Remote sync actions

Creating new remote offering sync

  1. Go to the Remote Offering Sync Management page and click Add.
  2. A popup will open with the necessary fields to be filled in.

  3. Fill in the required fields:

    • Remote API URL: The API URL of the remote Waldur instance. This is typically the User Interface URL with /api at the end.
    • Authentication token: The integration user’s authentication token from the remote Waldur instance.
    • Remote organization: Select the remote organization that will request orders in remote Waldur, and whose visibility scope determines which offerings are imported from remote Waldur.
    • Local service provider: Select the local service provider organization under which the imported offerings will be published.
    • Category mapping rules: Map the remote offering categories to the local ones.
    • Enable synchronization: Enable the sync now, or leave it disabled and enable it later.
    • Click Create.

    New remote sync

  4. If remote sync is enable, then local Waldur periodically (once per day) pulls inormation about offerings from the remote instance.

Reporting

HomePort reports

Waldur HomePort includes a number of built-in reports based on the user activity. Reports can be accessed by staff and support users from the "Reporting" sidebar menu.

Homeport reports
List of built-in reports in HomePort

Grafana and Prometheus Metrics

Waldur supports exporters to Prometheus of different statistical metrics that can be used for building business dashboards, for example, in Grafana.

Check out details about the setup of the exporter.

Example of OECD-science code report
Example of OECD-science code report

Custom reports

It is possible to implement custom metric collection and report generation using Waldur SDK. Several examples are provided in the section for integrators.

Team management for staff

Adding organization members

New user already has account in current Waldur instance

  1. Open the organization in Waldur.
  2. Select "Team" from the menu and click on "Users".

  3. By clicking "Add member" open "Add organization member" window.

    Select organization

  4. Select correct user, set the role and expiration date if necessary.

    Select organization

  5. Finally, click on "Add".

  6. User now will be added to the organization.

User role management

Overview

Staff users can manage user roles through the platform's role management interface. This includes configuring existing roles, creating new ones, and adjusting role permissions to ensure appropriate access levels across different organizational contexts.

Accessing role management

  1. Navigate to Administration in the main menu
  2. Select Settings
  3. Click on User roles

User role management

Managing existing roles

Viewing roles

The roles interface displays all existing roles with their associated types and descriptions.

Role actions

For each role, administrators can:

  1. Edit role

    • Modify role name
    • Change role type
    • Adjust permissions

  2. Edit description

    • Update role description
    • Add clarifying information

  3. Disable role

    • Temporarily deactivate role
    • Prevent new assignments

Creating new roles

  1. Click Add new role
  2. Complete the required fields:
    • Name - Descriptive title for the role
    • Type - Select role context
    • Permissions - Configure permissions

Available role types

  • Organization
  • Project
  • Offering
  • Call
  • Proposal
  • Service provider organization
  • Call managing organization

Permission configuration

Permissions in Waldur are extensively categorized to provide granular access control across different functional areas. Each permission category contains multiple specific actions that can be enabled or disabled.

Offering permissions

  • Controls the complete lifecycle of offerings
  • Includes creation, modification, and deletion capabilities
  • Manages offering components like endpoints, screenshots, and plans
  • Controls offering states (pause/unpause/archive)
  • Manages offering-specific user groups and campaigns
  • Configures offering attributes, location, and description

Order permissions

  • Manages the order workflow process
  • Controls order visibility and listing
  • Handles order approval processes (both public and private)
  • Manages order cancellation and rejection
  • Controls order destruction capabilities

Provider actions

  • Manages service provider operations
  • Controls resource management and reporting
  • Handles API and robot account management
  • Provides access to service provider statistics and revenue
  • Manages provider-customer relationships
  • Controls backend integration settings

Customer actions for resources

  • Controls resource visibility and management
  • Handles resource lifecycle operations
  • Manages booking requests and plan switching
  • Controls resource limitations and options
  • Manages importable resources

Team member permissions

  • Controls invitation management
  • Manages permission assignments across projects, customers, and offerings
  • Handles creation, updating, and deletion of various permission types
  • Controls access level modifications

Project permissions

  • Manages project lifecycle
  • Controls project creation and modification
  • Handles project listing and deletion
  • Sets project-level access controls

Call management

  • Controls call and round management
  • Handles proposal workflows
  • Manages permission assignments for calls
  • Controls proposal approval processes
  • Manages round closures

Service desk configuration

Waldur offers a convenient way to integrate with popular service desk solutions like Atlassian, Zammad, and Smax. With this integration, you can manage service desk tickets directly within Waldur.

To set up the configuration, navigate to the Service Desk configuration page by going to Administration -> Service Desk.

  • Waldur support enabled - Toggle Yes if you want to use support plugin.
  • Waldur support active backend type - Select the active configuration.
  • Waldur support display request type - Toggle to show the request type.

Service desk configuration

Atlassian configuration

To configure Atlassian for Waldur, open the Service Desk configuration page and select Configure from the Atlassian box.

A popup will appear. Fill in the required fields and click Update.

  • Atlassian API server URL – The base URL for connecting to the Atlassian API.
  • Username for access user – The username of the account used for API authentication.
  • Password for access user – The password for the access user (if required).
  • Email for access user – The email address associated with the access user.
  • Token for access user – An authentication token used instead of a password for secure access.
  • Service desk ID or key – The identifier for the service desk in Jira Service Management.
  • Issue type used for request-based item processing – Defines which issue type (e.g., "Service Request") is used for handling requests.
  • Comma-separated list of file extensions not allowed for attachment – Specifies file types that cannot be uploaded.
  • Atlassian issue types – Lists the types of issues available (e.g., Informational, Service Request, Change Request, Incident).
  • Affected resource field name – The field name that captures the impacted resource.
  • Template for issue description – A predefined format for issue descriptions.
  • Template for issue summary – A predefined format for issue summaries.
  • Impact field name – The field used to store impact-related information (e.g., "Impact").
  • Organisation field name – Maps the field for the organization associated with the issue (e.g., "Reporter organization").
  • Resolution SLA field name – Defines the field tracking SLA (Service Level Agreement) resolution time.
  • Project field name – Stores the project identifier for an issue.
  • Reporter field name – Identifies the original reporter of an issue (e.g., "Original Reporter").
  • Caller field name – Refers to request participants (e.g., users involved in the request process).
  • SLA field name – Specifies the field used for tracking SLA metrics (e.g., "Time to first response").
  • Type of linked issue field name – Defines the field used to categorize linked issues (e.g., "Relates").
  • Customer satisfaction field name – Captures customer satisfaction ratings (e.g., "Customer satisfaction").
  • Request feedback field name – Stores feedback related to the request (e.g., "Request feedback").
  • Template field name – Allows specifying a template for issue creation.
  • Atlassian custom issue field mapping enabled – Allows enabling/disabling custom field mapping.
  • Atlassian shared username – Enables a shared username across different configurations.
  • Atlassian verify SSL – Controls whether SSL certificates should be verified for security.
  • Atlassian use old API – Enables compatibility with older API versions.
  • Atlassian use automatic request mapping – When enabled, this setting allows automatic mapping of incoming requests to the appropriate Atlassian issues or service desk requests.
  • Atlassian map Waldur users to service desk agents – This suggests an integration between Waldur and Atlassian's service desk. Enabling this would map Waldur users to service desk agent roles.
  • Atlassian pull priorities – If enabled, it allows the system to synchronize or pull priority levels from Atlassian issues to maintain consistent prioritization.

Atlassian configuration Atlassian configuration Atlassian configuration

Zammad configuration

To configure Zammad for Waldur, open the Service Desk configuration page and select Configure from the Zammad box.

A popup will appear. Fill in the required fields and click Update.

  • Zammad API server URL - Zammad instance API URL.
  • Authorization token - Zammad instance API token.
  • Zammad group - Zammad instance group under which the tickets are created.
  • Zammad article type - Zammad instance article type. Usually "email".
  • Zammad comment maker - Additional comment line in Zammad, if the ticket is created in Waldur.
  • Comment prefix with user info - Additional comment line in Zammad with user name, who created the ticket.
  • Zammad comment cooldown duration - Time (in seconds) to remove the comment until it is saved in the system.

Zammad configuration

Smax configuration

To configure Smax for Waldur, open the Service Desk configuration page and select Configure from the Smax box.

A popup will appear. Fill in the required fields and click Update.

  • SMAX API server URL - Enter the URL of the SMAX API server to enable communication between Waldur and SMAX.
  • User tenant ID - Provide the unique tenant ID associated with your SMAX user account.
  • Authorization login - Enter the login credentials used to authenticate with the SMAX service.
  • Authorization password - Enter the password associated with the authorization login.
  • Organisation field name - Specify the field name that identifies the organization in SMAX.
  • Project field name - Specify the field name used to identify the project in SMAX.
  • Resource field name - Provide the field name used for identifying resources in SMAX.
  • Requests offering code for all issues - Provide the offering code that corresponds to the issues in SMAX.
  • Duration in seconds of delay between pull user attempts - Set the duration (in seconds) between attempts to pull user data from the backend.
  • The maximum number of attempts to pull user from backend - Set the maximum number of attempts to pull user data from the backend before the process is stopped.
  • Creation source name - Specify the source name used when creating tickets or records in SMAX.
  • Smax verify ssl - Toggle this setting to enable or disable SSL verification when communicating with the SMAX server.

Smax configuration

Service desk interactions

This guide will help you navigate and effectively use the support system to manage service requests, track tickets, and communicate with users.

Accessing the service desk support tickets

To view service desk support tickets:

  1. Select Support from the left-hand menu.
  2. Click Requests from the top menu.

A page will open displaying all created tickets. You can view:

  • The status of each ticket.
  • The user name and organization that created the ticket.

Service desk tickets

To open a specific ticket, click on its key-name. This will open a dedicated ticket page.

Service desk tickets

On this page, you can:

  • Read the content of the ticket.
  • Check attachments.
  • Add comments/replies to communicate with users.

Ended: Service desk

Ended: Staff users

Ended: User guide